Skip to navigation
Modbox APIsandboxes

Get a sandbox

View as Markdown

Returns the full record for one sandbox, including its lifecycle status and the public sandbox_url.

Poll this endpoint after provisioning: sandbox_url is null until status becomes running.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

sandbox_idstringRequiredformat: "uuid"

Headers

x-workspace-idstring or nullOptional

UUID of the workspace that scopes this request. List the workspaces you belong to with GET /workspaces.

Response

Successful Response
idstringformat: "uuid"
namestring

The task_id used when the sandbox was provisioned.

statusenum

Lifecycle state. The sandbox is usable only while running.

Allowed values:
created_bystring
Id of the user who created it.
created_atdatetime
updated_atdatetime
sandbox_urlstring or nullOptional

Public URL. Null until status is running.

imagestring or nullOptional
Container image in use.
destroyed_atdatetime or nullOptional
expires_atdatetime or nullOptional
When the TTL reaper will destroy it. Null means no expiry.
capabilitiesmap from strings to strings or nullOptional

Absolute URLs for what this sandbox exposes, keyed by capability. Null until the sandbox is running. Read this rather than assuming paths — they differ between images.

Authenticate against exec and files with the access_token returned when the sandbox was created.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error