SandboxesLifecycle

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, set discard_memory.
  • disk_node_unavailable (with discard_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 (with discard_memory): the resume failed after the memory was discarded. The sandbox is suspended. To retry, resume without discard_memory.
PUT
/v1/sandboxes/{idOrName}/resume
AuthorizationBearer <token>

API key starting with tektona_. Create one at app-dev.tektona.ai under API Keys.

In: header

Path Parameters

idOrName*string

Sandbox ID (ULID) or name

Query Parameters

org?string

Required when the path names the sandbox by name.

project?string

Required when the path names the sandbox by name.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

discard_memory?boolean

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.

Defaultfalse

Response 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"}