Skip to navigation
Modbox APIsandboxes

Block until a sandbox is ready

View as Markdown

Long-polls until the sandbox accepts traffic or timeout seconds elapse. Call this right after POST /sandboxes/provision.

On timeout the response is ready: false rather than an error — always check the field before using the sandbox, and call again to keep waiting. Keep timeout below any proxy idle limit on your side.

Authentication

AuthorizationBearer

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

Headers

x-workspace-idstring or nullOptional

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

Request

This endpoint expects an object.
task_idstringRequired1-255 characters
The name used when the sandbox was provisioned.
timeoutintegerOptional1-600Defaults to 120

Seconds to wait before giving up. The call returns ready: false on timeout rather than failing.

poll_intervalintegerOptional1-60Defaults to 5
Seconds between readiness checks.

Response

Successful Response
readyboolean

True when the sandbox became ready. False means the timeout elapsed first — call again to keep waiting.

elapsed_secondsdoubleOptionalDefaults to 0
How long the call actually waited.

Errors

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