Skip to main content
POST
Stop a sandbox twin

Authorizations

Authorization
string
header
required

Access token issued by WorkOS AuthKit.

Path Parameters

sandbox_id
string<uuid>
required
sandbox_twin_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
twin_slug
string
required
desired_state
string
required

running or stopped

state
string
required

What the twin is actually doing: pending, provisioning, starting, ready, stopping, stopped or failed.

url
string
required
created_at
string<date-time>
required
twin_version
string | null

The release the current container was started from.

failure
string | null

Why the current run is not serving, if it is not.

ready_at
string<date-time> | null