Resume a sandbox
Resume a paused (hibernated or suspended) sandbox.
- A hibernated sandbox resumes with its memory only on a runner node whose CPU can restore it.
- With
discard_memory, a hibernated sandbox starts from its disk instead. Its memory image is deleted, and it can run on any node with room.
A refusal can carry its cause code in the problem type, all with 503:
memory_restore_no_capacity: no node can restore the memory now. The sandbox keeps the memory. To resume now, setdiscard_memory.disk_node_unavailable(withdiscard_memory): the disk is only on the node that paused the sandbox, and that node is unavailable or full. The memory is kept.memory_discarded(withdiscard_memory): the resume failed after the memory was discarded. The sandbox is suspended. To retry, resume withoutdiscard_memory.
Authorization
apiKey API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.
In: header
Path Parameters
Sandbox ID (ULID) or name
Query Parameters
Required when the path names the sandbox by name.
Required when the path names the sandbox by name.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Start a hibernated sandbox from its disk without its memory. The memory image is deleted, and running processes and memory contents are lost. Valid only for a hibernated sandbox.
falseResponse Body
application/json
application/problem+json
curl -X PUT "https://example.com/v1/sandboxes/string/resume" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "state": "creating"}{ "detail": "Property foo is required but is missing.", "errors": [ { "location": "string", "message": "string", "value": null } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example"}Resize a sandbox PUT
Change the CPU, memory, or disk allocation of a sandbox. Only provided fields change. - Disk only grows, and grows at once. - CPU and memory grow live on a running sandbox that supports it. Otherwise they apply on the next reboot. - Set `mode` to `live` to fail instead of waiting, or to `deferred` to always wait for the reboot. - A live resize only grows. To shrink memory, set `force`. The change applies on the next reboot. A refusal carries its cause code in the problem type: - 409 for `no_capacity`, `claim_failed`, `resize_in_flight` and `disk_resize_failed`. Nothing changed. - 422 for `shrink_unsupported`, `not_running`, `no_hotplug_limits`, `above_hotplug_limit` or another runner code. - 502 for `live_resize_unknown`: the dispatch came back without a decision, and the change waits as pending.
Update lifecycle config PUT
Update the lifecycle configuration for a sandbox.