SandboxesLifecycle

Pause a sandbox

Pause a running sandbox via hibernate or suspend mode.

PUT
/v1/sandboxes/{idOrName}/pause
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.

mode?string

Pause mode.

Default"hibernate"

Value in

  • "hibernate"
  • "suspend"

Response Body

application/json

application/problem+json

curl -X PUT "https://example.com/v1/sandboxes/string/pause" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "state": "creating"}