Skip to main content
DELETE
Delete sandbox

Authorizations

Authorization
string
header
default:Bearer {API_ACCESS_TOKEN}
required

CoreWeave API access token sent as a bearer token.

Path Parameters

sandboxId
string
required

Query Parameters

gracePeriodSeconds
integer<int32>

Grace period before forced termination. Zero or omission terminates immediately; positive values are clamped to the platform maximum. The effective deadline bounds drain and snapshot.

snapshotVolumes
string[]

Names of scratch SandboxSpec.volumes to snapshot before terminating; empty snapshots nothing. Each name must reference a scratch (not registered) volume declared on the sandbox spec: a registered-Volume-backed name is rejected with CWSANDBOX_VOLUME_NOT_SNAPSHOTTABLE, an unknown name with INVALID_ARGUMENT. Asynchronous — see the response.

Field 3 formerly held a bool snapshot; it was repurposed to this repeated string as a deliberate breaking change while v1 is pre-GA (no live clients). Old bool snapshot=true senders are unsupported — the value is dropped.

requestId
string

Optional receipt for a snapshot-on-delete request. Retrying the same request with the same token returns the original snapshot ids without redispatching the destructive command. Reusing it with different known request fields is rejected. This field is ignored when snapshot_volumes is empty: Plain Delete is naturally idempotent, does not inspect or persist a snapshot receipt, and retains the v1beta2 cancel-then-stop lifecycle. Snapshot volume order is part of request identity. Without a token, retrying snapshot-on-delete may create and dispatch a new batch. An exact replay returns the original receipt even when its snapshots failed; inspect the returned sandbox and snapshot states before retrying the delete with a new token. Tokens are limited to 128 UTF-8 bytes.

allowMissing
boolean

If true, deleting an absent sandbox succeeds instead of returning NOT_FOUND.

Response

OK

sandbox
object

The sandbox, now in STATE_TERMINATING/STATE_TERMINATED.

fileSystemSnapshotIds
string[]

One id per DeleteSandboxRequest.snapshot_volumes entry, in request order; poll GetFileSystemSnapshot for terminal status. A returned id always means a snapshot row exists (never a silent no-op). Termination proceeds regardless of snapshot outcome — for a guaranteed snapshot, call CreateFileSystemSnapshot and confirm READY before deleting.