Sign in

v7

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-01-26163065.1 KB

post/v1/sandboxes/{id}/snapshot

Path parameters

idstring required

Sandbox ID

Sandbox ID

Request body

namestring

Custom snapshot name (auto-generated if not provided)

quickboolean

Quick mode: fsfreeze only (faster but crash-consistent)

Example request

{
  "name": "my-snapshot-backup",
  "quick": false
}

Response

Snapshot created

idstring required

Snapshot ID (Kubernetes UID)

namestring required

Snapshot name

source_sandbox_idstring required

Source sandbox ID

source_sandbox_namestring required

Source sandbox name

status'creating' | 'ready' | 'error' required

Snapshot status

created_atstring required

Creation timestamp

consistency'application' | 'crash' required

Snapshot consistency level

Example response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "my-snapshot-backup",
  "source_sandbox_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "source_sandbox_name": "my-sandbox",
  "status": "ready",
  "created_at": "2024-01-17T20:00:00Z",
  "consistency": "application"
}