Create an additional named entity sandbox

POST

/entity-sandboxes

Provisions an additional, user-named shadow entity on the sandbox server for a live entity that already has its default sandbox set up. Use this when you want more than one isolated sandbox environment for the same entity — for example to model separate test scenarios side by side.

This differs from the default sandbox that is auto-provisioned (fire-and-forget) when an entity is created: this call is synchronous, so the response only returns once the sandbox server has confirmed activation, and any provisioning failure is surfaced back to the caller instead of being silently retried later.

The caller must already have can_view_entity (or wildcard *) ACL access to the entity_id supplied, and the identity must already have a sandbox identity provisioned (this happens automatically the first time any entity sandbox is created for the identity). The name must be unique among sandboxes belonging to the same entity.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The additional entity sandbox was provisioned on the sandbox server and the record created successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/entity-sandboxes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "entity_id": "01JXYZ1234567890ABCDEFGHIJ",
    "name": "QA Testing"
}'

Response Example

201 - Success

{
    "message": "Additional entity sandbox created successfully",
    "status": "success",
    "data": {
        "id": "01JQAB1234567890ABCDEFGHIJ",
        "entity_id": "01JXYZ1234567890ABCDEFGHIJ",
        "name": "QA Testing",
        "is_default": false,
        "activation_status": "completed",
        "sandbox_entity_id": "sbx_ent_9f3c7a2b"
    }
}

Modified at 2026-09-28 09:30:45

Terminate an identity session

Delete an entity sandbox