Skip to navigation
Modbox APIsandboxes

Check whether a sandbox is ready

View as Markdown

Lightweight readiness check against the running container, keyed by the task_id used at provision time.

Prefer GET /sandboxes/detail/{sandbox_id} when you also need the sandbox_url and the persisted record.

Authentication

AuthorizationBearer

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

Path parameters

task_idstringRequired

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
readyboolean
True when the sandbox is accepting traffic.
namestring or nullOptional
Internal resource name of the running sandbox.
errorstring or nullOptional
Reason the status could not be determined.

Errors

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