SandboxesAccess

Fork a sandbox

Create a point-in-time fork of a running sandbox. The source sandbox continues running.

POST
/v1/sandboxes/{idOrName}/fork
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

Fork mode: 'filesystem' (disk only) or 'full' (memory + disk).

Default"filesystem"

Value in

  • "filesystem"
  • "full"
name?|

Sandbox name: lowercase letters, digits and hyphens, 1 to 40 characters, no hyphen at the start or the end. Unique among the live sandboxes of the project. It must not be a ULID (the sandbox ID format). The fork never takes the name of the source. Omit or send null for no name.

Match^[a-z0-9]([a-z0-9-]*[a-z0-9])?$
Lengthlength <= 40
tags?array<string>

Tags for the fork. Omit to inherit, or provide an empty array for no tags.

Itemsitems <= 20

Response Body

application/json

application/problem+json

curl -X POST "https://example.com/v1/sandboxes/string/fork" \  -H "Content-Type: application/json" \  -d '{}'
{  "cache_key": "string",  "id": "string",  "image_ref": "string",  "name": "string",  "state": "creating",  "tags": [    "string"  ]}