Reset a shadow entity's sandbox

POST

/entity-sandbox-resets

Deletes and re-provisions a fresh copy of a shadow entity on the sandbox server, while keeping the same dashboard card (_id, name, is_default are preserved). Use this when a sandbox entity has drifted or you simply want a clean slate for testing.

The caller must have can_edit_entity or wildcard * ACL access to the live entity that the sandbox shadows. The reset is blocked while a create/reset is already in progress for the same sandbox (activation_status is pending). During the reset, activation_status is set to pending, then to completed on success or failed if provisioning on the remote sandbox server fails.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The sandbox entity was reset and re-provisioned successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/entity-sandbox-resets' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "entity_sandbox_id": "01JABC1234567890ABCDEFGHIJ"
}'

Response Example

201 - Success

{
    "message": "Entity sandbox reset successfully",
    "status": "success",
    "data": {
        "id": "01JABC1234567890ABCDEFGHIJ",
        "entity_id": "01JXYZ9876543210ZYXWVUTSRQ",
        "name": "Default sandbox",
        "is_default": true,
        "activation_status": "completed",
        "sandbox_entity_id": "sbx_ent_7f3a9c1d"
    }
}

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

Credit test money into an entity's sandbox wallet

Get or create the sandbox identity for the authenticated identity