Delete an entity sandbox

DELETE

/entity-sandboxes/{id}

Removes a shadow entity sandbox. The endpoint first proxies a DELETE /entities/:id call to the sandbox server (authenticated with the owning identity's sandbox master key) to remove the remote shadow entity, then soft-deletes the local entity-sandbox bookkeeping record.

The default sandbox for an entity (the one auto-provisioned when the entity itself was created) can never be deleted through this endpoint, and a sandbox that is still pending activation cannot be deleted either — wait for provisioning to finish (or fail) before retrying.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

The entity sandbox was deleted successfully (or was already deleted remotely, in which case only the local record is removed).

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE '/entity-sandboxes/01JQAB1234567890ABCDEFGHIJ' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "message": "Entity sandbox deleted successfully",
    "status": "success",
    "data": {
        "id": "01JQAB1234567890ABCDEFGHIJ",
        "deleted": true
    }
}

Modified at 2026-09-30 00:29:45

Create an additional named entity sandbox

Rename an entity sandbox