v49

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01151216390.1 KB

Devbox

Devbox-PersistenceTools

Start an asynchronous disk snapshot of a running Devbox.

Start an asynchronous disk snapshot of a devbox with the specified name and metadata. The snapshot operation will continue in the background and can be monitored using the query endpoint.

post/v1/devboxes/{id}/snapshot_disk_async

Path parameters

idstring required

The Devbox ID.

Request body

namestring nullable

(Optional) A user specified name to give the snapshot

metadataobject nullable

(Optional) Metadata used to describe the snapshot

commit_messagestring nullable

(Optional) Commit message associated with the snapshot (max 1000 characters)

Response

Snapshot operation started successfully.

idstring required

The unique identifier of the snapshot.

namestring nullable

(Optional) The custom name of the snapshot.

create_time_msinteger required

Creation time of the Snapshot (Unix timestamp milliseconds).

metadataobject required

User defined metadata associated with the snapshot.

source_devbox_idstring required

The source Devbox ID this snapshot was created from.

source_blueprint_idstring nullable

(Optional) The source Blueprint ID this snapshot was created from.

commit_messagestring nullable

(Optional) The commit message of the snapshot (max 1000 characters).

size_bytesinteger nullable

(Optional) The size of the snapshot in bytes, relative to the base blueprint.