compute

Create sandbox snapshot

Creates a point-in-time snapshot of a sandbox. Snapshots capture the sandbox state and can be used for forking into new sandboxes or applications. This is a WIP endpoint — the full implementation depends on the execution plane.

post/sandboxes/{sandboxName}/snapshots

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopessandboxes:update
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/sandboxes/:sandboxName/snapshots/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

sandboxNamestring required

Name of the sandbox to snapshot

Request body

namestring

Optional human-readable name for the snapshot

Example request

{
  "name": "before-migration"
}

Response

Snapshot created successfully

createdAtstring required

When the snapshot was created

createdBystring

Who created the snapshot

idstring required

Unique snapshot identifier

namestring

Optional human-readable name for the snapshot

sandboxNamestring required

Name of the source sandbox

statusstring required

Status of the snapshot (pending, ready, failed)

workspacestring required

Workspace of the source sandbox

Example response

{
  "id": "snap_abc123",
  "name": "before-migration",
  "status": "ready"
}

Changes

No recorded changes to this operation across all 1 revision of this API.