snapshots

Create a snapshot

post/v1/orgs/{slug}/snapshots

Path parameters

slugstring required

Organization slug

dest_dirstring nullable

Directory on a mounted host volume to write the artifact into. None stores the snapshot in managed snapshot storage.

forceboolean

Replace an existing snapshot with the same name.

labelsobject

User-defined labels stored on the snapshot.

namestring required

Snapshot name.

record_integrityboolean

Record payload integrity metadata during capture.

sandbox_idstring required

Immutable identifier of the sandbox to capture.

kind'disk' required

Snapshot capture queued

completed_atstring date-time nullable

Timestamp of the terminal status, when the operation has finished.

created_atstring date-time required

Creation timestamp.

idstring required

Server-side operation identifier.

kind'disk' required

Kind of cloud snapshot artifact or capture operation.

status'queued' | 'in_progress' | 'succeeded' | 'failed' required

Status of an asynchronous cloud snapshot operation.

updated_atstring date-time required

Timestamp of the most recent status change.

Changed in 1 of the 5 revisions of this API.1