Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The Devbox ID.

Body

application/json
name
string | null

(Optional) A user specified name to give the snapshot

metadata
object | null

(Optional) Metadata used to describe the snapshot

commit_message
string | null

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

Response

Snapshot operation started successfully.

id
string
required

The unique identifier of the snapshot.

create_time_ms
integer<int64>
required

Creation time of the Snapshot (Unix timestamp milliseconds).

metadata
object
required

User defined metadata associated with the snapshot.

source_devbox_id
string
required

The source Devbox ID this snapshot was created from.

name
string | null

(Optional) The custom name of the snapshot.

source_blueprint_id
string | null

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

commit_message
string | null

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

size_bytes
integer<int64> | null

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