Skip to main content
GET
Get sandbox

Authorizations

Authorization
string
header
default:Bearer {API_ACCESS_TOKEN}
required

CoreWeave API access token sent as a bearer token.

Path Parameters

sandboxId
string
required

Sandbox UUID or tenant-scoped display_name. Names resolve active sandboxes only; use the UUID to retrieve a terminal sandbox. UUIDs resolve by ID only. Use the returned sandbox_id for subsequent operations, since names can be reused after termination. Existing ownership and access rules apply.

Response

OK

Sandbox is a single running (or terminal) compute environment.

spec
object
required

Desired workload. Required on create and immutable thereafter. It is absent when v1 projects a sandbox created through v1beta2, which has no v1 SandboxSpec. It is also absent in STATE_PREPARING, and after an image fill fails before the spec is stored. When create used a template, this is the resolved spec from that create — never re-read from the live template.

sandboxId
string
read-only

Server-assigned unique identifier.

status
object

Observed state.

sourceTemplateId
string
read-only

Template selected at create time, if any. Historical provenance; retained even if the template is later deleted.

sourceTemplateRevision
string
read-only

Revision of the template applied at create time.

displayName
string

Optional, immutable lookup name, unique among active sandboxes in the tenant organization. Case-sensitive, at most 128 UTF-8 bytes; leading or trailing whitespace, slashes, colons, control characters, and UUIDs are invalid. The name becomes reusable once the sandbox reaches a terminal state.

endpointShareToken
string
read-only

CreateSandbox, CreateSandboxFromTemplate, and an identical request_id replay of that call, after HTTPS URLs confirm. Omitted from Get, List, status, and from a successful create while those URLs are unconfirmed. Send as X-Sandbox-Share-Token or ?share_token=; both are stripped before forwarding.

control
enum<string>
read-only

Who controls the sandbox's containers: CONTROL_CONTAINER_ENGINE for a sandbox created with it, and CONTROL_PLATFORM for every other sandbox. CONTROL_UNSPECIFIED means no controller is specified; successful creates resolve the default to CONTROL_PLATFORM.

Available options:
CONTROL_UNSPECIFIED,
CONTROL_PLATFORM,
CONTROL_CONTAINER_ENGINE