Create Snapshot

POST /v1/volumes/{id}/snapshot

Description

Create a snapshot for a volume.

Authorizations

Header: x-api-key (string) — API key provided in the x-api-key header. Required.

Path parameters

• id (string) — required — Volume ID

Body (application/json)

• name (string) — required — Snapshot name

• quick (boolean) — default: false — Quick mode: Only fsfreeze (crash-consistent). Default: Full sync + freeze (application-consistent)

Example body:

request.json

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

Responses

201 — application/json

Response fields:

• id (string) — required — Snapshot ID

• name (string) — required — Snapshot name

• volume_id (string) — required — Source volume ID

• volume_name (string) — required — Source volume name

• sandbox_id (string) — required — Sandbox ID that was using the volume

• sandbox_name (string) — required — Sandbox name that was using the volume

• status (string) — required — Snapshot status

• consistency (string) — required — Snapshot consistency level (application-consistent or crash-consistent)

• created_at (string) — required — Creation timestamp