Skip to main content
POST
Purge sandboxes

Authorizations

Authorization
string
header
default:Bearer {API_ACCESS_TOKEN}
required

CoreWeave API access token sent as a bearer token.

Body

application/json
tags
string[]

Scope selector: sandboxes matching all tags (AND). Must be non-empty unless purge_all is true.

dryRun
boolean

Dry-run guard. false (default) terminates the matched sandboxes; true reports how many sandboxes would be purged and terminates nothing.

requestId
string

Idempotency key (AIP-155), reserved for future support. Non-empty values are currently rejected with UNIMPLEMENTED.

purgeAll
boolean

Scope selector: match every active in-scope sandbox. Mutually exclusive with tags, and required when tags is empty.

Response

OK

purgeCount
integer<int32>

Number of sandboxes successfully purged, or, on a dry-run (dry_run=true), the number that would be purged.

failedSandboxIds
string[]

Ids of sandboxes that matched but could not be terminated; retry to purge them. Empty on a dry-run (dry_run=true).

retryableFailedSandboxIds
string[]

Subset of failed_sandbox_ids whose failure was retryable. These sandboxes were not purged by this request, but may converge on a later retry (for example placement or route reconciliation was still in flight).