Pause a running sandbox

Pause a running sandbox

POST /api/v1/sandbox/{id}/pause

cURL

curl --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause' \
  --header "Authorization: Bearer $STATESET_SANDBOX_API_KEY"

200

{
  "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "paused"
}

Path parameters

id · string (uuid) · required

Sandbox identifier

Response

object

sandbox_id · string (uuid) · required

status · string · required

Status codes

Code	Meaning
200	Sandbox paused
404	Sandbox not found
409	Sandbox not in a pausable state

cURL

curl --request POST \
  --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/pause' \
  --header "Authorization: Bearer $STATESET_SANDBOX_API_KEY"

200

{
  "sandbox_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "paused"
}