x-cpod-domain: pods
Pods
Platform compute pods — create, manage, and lifecycle-control containerised workloads within workspaces.
Try in explorer
client.podsPod
A containerised compute workload running inside a workspace.
REST path
/api/v1/podsOperations
listgetcreateupdatedeletestartstopSDK
// 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: {},
})| Field | Type | Description |
|---|---|---|
| id* | uuid | Pod UUID. |
| workspace_id* | uuid→Workspace | Owning workspace. |
| organization_id* | uuid→Organization | Owning organization. |
| name* | string | Pod name (unique within workspace). |
| status* | enum | Pod lifecycle status.provisioningrunningstoppingstoppedfailed |
| spec* | json | Pod spec: image, cpu, memory, replicas. |
| labels | json | Key-value labels for filtering and grouping. |
| annotations | json | Arbitrary metadata annotations. |
| created_at* | date-time | Creation timestamp. |
| updated_at* | date-time | Last update timestamp. |