Stop and delete a sandbox

Stop and delete a sandbox

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

cURL

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

200

{
  "success": true,
  "usage": {
    "duration_ms": 8,
    "cpu_ms": 250,
    "memory_gb_ms": 250,
    "network_bytes_in": 1,
    "network_bytes_out": 1
  }
}

Path parameters

id · string (uuid) · required

Sandbox identifier

Response

object

success · boolean · required

usage · object

Final usage report for the sandbox. Omitted when usage reporting failed.

Show usage

duration_ms · integer

cpu_ms · integer

memory_gb_ms · integer

network_bytes_in · integer

network_bytes_out · integer

Status codes

Code	Meaning
200	Sandbox stopped
404	Sandbox not found

cURL

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

200

{
  "success": true,
  "usage": {
    "duration_ms": 8,
    "cpu_ms": 250,
    "memory_gb_ms": 250,
    "network_bytes_in": 1,
    "network_bytes_out": 1
  }
}