Delete a sandbox

You can delete a sandbox by making a DELETE request that includes the sandbox’s name in the request path.


Making this API call updates the sandbox’s status property to “deleted” and deactivates it. GET requests can still retrieve sandbox’s details after it has been deleted.

API format

Parameter Description
{SANDBOX_NAME} The name of the sandbox you want to delete.


The following request deletes a sandbox named “dev-2”.

curl -X DELETE \ \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'


A successful response returns the sandbox’s updated details, showing that its state is “deleted”.

    "name": "dev-2",
    "title": "Development 2",
    "state": "deleted",
    "type": "development",
    "region": "VA7"

On this page