Skip to main content
POST
Create file system snapshot

Authorizations

Authorization
string
header
default:Bearer {API_ACCESS_TOKEN}
required

CoreWeave API access token sent as a bearer token.

Path Parameters

sandboxId
string
required

Body

application/json
sandboxId
string
required
requestId
string

Optional idempotency token, limited to 128 UTF-8 bytes.

scratchVolumeName
string

Which scratch volume to snapshot (the SandboxVolume.name of a scratch entry). Registered-Volume-backed entries are not snapshottable (naming one fails with CWSANDBOX_VOLUME_NOT_SNAPSHOTTABLE) and are excluded from the defaulting count. Optional when the sandbox has a single scratch volume; required when it has more.

Response

OK

fileSystemSnapshotId
string
read-only
state
enum<string>
read-only

Reported snapshot state. SNAPSHOT_STATE_UNSPECIFIED means no recognized public state is available for the stored state.

Available options:
SNAPSHOT_STATE_UNSPECIFIED,
SNAPSHOT_STATE_CREATING,
SNAPSHOT_STATE_READY,
SNAPSHOT_STATE_FAILED,
SNAPSHOT_STATE_DELETING
stateReason
string
read-only
sizeBytes
string
read-only
sourceSandboxId
string
read-only
trigger
enum<string>
read-only

Reported creation trigger. SNAPSHOT_TRIGGER_UNSPECIFIED means no recognized public trigger is available for the stored trigger; it does not imply manual creation.

Available options:
SNAPSHOT_TRIGGER_UNSPECIFIED,
SNAPSHOT_TRIGGER_MANUAL,
SNAPSHOT_TRIGGER_ON_DELETE
createTime
string<date-time>
read-only
completeTime
string<date-time>
read-only
sourceVolumeName
string
read-only

Name of the source volume this snapshot was taken from.

objectBucket
string
read-only

Object-storage bucket the snapshot archive landed in.

updatedAt
string<date-time>
read-only

When the snapshot record was last updated.

requestId
string
read-only

Echoes the request_id supplied to CreateFileSystemSnapshot, if any.