Payload schema
pathstring
The claimed sandbox path (/sandboxes/<name>) — the idempotency-keyed catalogue append is the atomic claim on this name.
instanceType"lite" | "basic" | "standard-1" | "standard-2" | "standard-3" | "standard-4"
Cloudflare container instance type, fixed for the sandbox's whole life; routes every later get(path) to the right container namespace.
sleepAfterstring | numberoptional
Idle window before the automatic snapshot-and-teardown: a positive number of seconds or "<n>s"/"<n>m"/"<n>h" (the SDK's own format).
keepAlivebooleanoptional
When true, the idle timer never tears the container down.
envRecord<string, string | null>optional
Initial env-var map, applied as if by setEnvVars (key → getSecret placeholder or non-secret literal; null unsets). Never raw secret material — this lands on a durable stream.
Raw JSON schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The claimed sandbox path (/sandboxes/<name>) — the idempotency-keyed catalogue append is the atomic claim on this name."
},
"instanceType": {
"type": "string",
"enum": [
"lite",
"basic",
"standard-1",
"standard-2",
"standard-3",
"standard-4"
],
"description": "Cloudflare container instance type, fixed for the sandbox's whole life; routes every later get(path) to the right container namespace."
},
"sleepAfter": {
"description": "Idle window before the automatic snapshot-and-teardown: a positive number of seconds or \"<n>s\"/\"<n>m\"/\"<n>h\" (the SDK's own format).",
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"keepAlive": {
"description": "When true, the idle timer never tears the container down.",
"type": "boolean"
},
"env": {
"description": "Initial env-var map, applied as if by setEnvVars (key → getSecret placeholder or non-secret literal; null unsets). Never raw secret material — this lands on a durable stream.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
}
},
"required": [
"path",
"instanceType"
]
}