Docs

Docs

x-cpod-domain: pods

Pods

Platform compute pods — create, manage, and lifecycle-control containerised workloads within workspaces.

Try in explorer client.pods

Pod

A containerised compute workload running inside a workspace.

REST path/api/v1/pods
Operations
listgetcreateupdatedeletestartstop
SDK
// list — returns only your records; add filters/search:
await client.pods.list()

// create:
await client.pods.create({
  id: "rec_01HXEXAMPLE",
  workspace_id: "workspace_01HXEXAMPLE",
  organization_id: "organization_01HXEXAMPLE",
  name: "example name",
  status: "provisioning",
  spec: {},
})
FieldTypeDescription
id*uuidPod UUID.
workspace_id*uuidWorkspaceOwning workspace.
organization_id*uuidOrganizationOwning organization.
name*stringPod name (unique within workspace).
status*enumPod lifecycle status.provisioningrunningstoppingstoppedfailed
spec*jsonPod spec: image, cpu, memory, replicas.
labelsjsonKey-value labels for filtering and grouping.
annotationsjsonArbitrary metadata annotations.
created_at*date-timeCreation timestamp.
updated_at*date-timeLast update timestamp.