curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/fork' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"cpus": "1",
"memory": "1Gi",
"timeout_seconds": 250,
"isolation": "container",
"include_env": true,
"checkpoint_name": "string",
"checkpoint_description": "string"
}'
{
"parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"forked_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"checkpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "pending",
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"workspace_strategy": "file-checkpoint",
"startup_metrics": null
}
Fork a sandbox from a durable checkpoint
Sandbox forked successfully
POST
/
api
/
v1
/
sandbox
/
{id}
/
fork
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/fork' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"cpus": "1",
"memory": "1Gi",
"timeout_seconds": 250,
"isolation": "container",
"include_env": true,
"checkpoint_name": "string",
"checkpoint_description": "string"
}'
{
"parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"forked_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"checkpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "pending",
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"workspace_strategy": "file-checkpoint",
"startup_metrics": null
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string (uuid)
required
Sandbox identifier
Headers
string
Persist before first dispatch; exact retries retain principal, route, body and original result. Do not change keys to escape an uncertain mutation.
Request body
ForkSandboxRequest
string
string
integer
Minimum:
60. Maximum: 86400.string
Allowed values:
'container', 'gvisor', 'microvm', 'kata', 'wasm'.boolean
Default:
true.string
Minimum length:
1. Maximum length: 255.string
Maximum length:
1000.Response
ForkSandboxResponse
string
required
string
required
string
required
string
required
string
required
string
required
string
required
Allowed values:
'file-checkpoint', 'csi-snapshot'.any
Status codes
| Code | Meaning |
|---|---|
201 | Sandbox forked successfully |
400 | Invalid branch request |
404 | Source sandbox not found |
503 | Checkpoint service unavailable |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/fork' \
--header 'Authorization: ApiKey YOUR_API_KEY' \
--header "Idempotency-Key: ${IDEMPOTENCY_KEY:?Set a unique key for this operation; preserve it on retries}" \
--header 'Content-Type: application/json' \
--data '{
"cpus": "1",
"memory": "1Gi",
"timeout_seconds": 250,
"isolation": "container",
"include_env": true,
"checkpoint_name": "string",
"checkpoint_description": "string"
}'
{
"parent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"forked_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"checkpoint_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "pending",
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"workspace_strategy": "file-checkpoint",
"startup_metrics": null
}
Last modified on October 20, 2026