Delete All Sandboxes

Deletes all sandboxes.

Request

  • Method: DELETE

  • Path: /v1/sandboxes/delete-all

Authorization

circle-info

Provide your API key in the x-api-key request header. This header is required.

Response (200 — application/json)

Example response
{
  "message": "All sandboxes deleted successfully",
  "deleted_count": 3,
  "deleted_ids": [
    "sbx_x1y2z3a4b5c6d7e8",
    "sbx_y2z3a4b5c6d7e8f9",
    "sbx_z3a4b5c6d7e8f9g0"
  ]
}

Response fields

Field
Type
Required
Description

message

string

yes

Success message

deleted_count

number

yes

Number of sandboxes deleted

deleted_ids

string[]

yes

Array of deleted sandbox IDs

errors

object[]

no

Array of deletion errors, if any

errors (child attributes)

Field
Type
Required
Description

id

string

yes

Sandbox ID that failed to delete

error

string

yes

Error message

Last updated