API reference
Pods
18 operations. Each page has the request, the response, the errors and examples in curl, TypeScript, Python and the CLI.
- GETHardware for pods: per SKU, its prices and what can be launched now in each region
/v1/pods/hardware - GETPrice estimate for a pod configuration: hourly running and stopped cost
/v1/pods/estimate - GETList pods in the project (terminated pods are left out unless asked for)
/v1/pods - POSTCreate a pod from a template or an image (launch gate and quotas apply)
/v1/pods - GETGet a pod: its state, configuration and how to connect
/v1/pods/{pod_id} - PATCHRename a pod (does not touch the container)
/v1/pods/{pod_id} - POSTChange a pod’s configuration (recreates the container; only volume data survives)
/v1/pods/{pod_id}/reconfigure - POSTStart a stopped pod (placed again; on its volume’s host if it has one)
/v1/pods/{pod_id}/start - POSTStop a pod: compute released and no longer billed; volumes kept (and billed)
/v1/pods/{pod_id}/stop - POSTRestart the container in place (same host and GPUs; the container disk is kept)
/v1/pods/{pod_id}/restart - POSTReset a pod: recreate its container from the image with a fresh container disk (volumes kept)
/v1/pods/{pod_id}/reset - POSTTerminate a pod: the container is destroyed; its pod volume is deleted unless kept
/v1/pods/{pod_id}/terminate - POSTRun a command in the pod and wait for it (bounded time and output)
/v1/pods/{pod_id}/exec - POSTA single-use ticket (valid for seconds) to open the pod’s terminal WebSocket
/v1/pods/{pod_id}/terminal-tickets - GETThe pod’s timeline (oldest first): what the platform did and what its host reported
/v1/pods/{pod_id}/events - GETContainer output and platform events as a server-sent event stream
/v1/pods/{pod_id}/logs - GETCPU, memory, disk, network and GPU series for a time range
/v1/pods/{pod_id}/telemetry - POSTSave a pod’s configuration as a template (secrets are dropped from public ones)
/v1/pods/{pod_id}/templates