Developers
Sandbox5

Retrieve the sandbox

GET/sandbox

Describes the sandbox associated with the current credentials.

With production credentials, the response describes the linked sandbox. If no sandbox has been provisioned, the request still succeeds and status is absent. With sandbox credentials, the response describes the sandbox itself.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sandbox"
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "environment": "production",    "last_reset_at": "2019-08-24T14:15:22Z",    "last_reset_operation_id": "string",    "linked": true,    "object": "sandbox",    "scenario": {      "name": "string",      "seeded_at": "2019-08-24T14:15:22Z",      "version": 0    },    "status": "ready"  }}

Sandbox5

Sandbox in API v3: retrieve the sandbox, reset the sandbox, list test scenarios, retrieve a test scenario, run a test scenario.

Reset the sandbox POST

Deletes the sandbox data, including uploaded files, and seeds the default test data again. Credentials, administrators, and audit entries are preserved, and production data is never affected. Only sandbox credentials can request a reset. Production credentials receive `403 Forbidden` with the `sandbox_only` error code. Only one reset can be queued or running at a time. The reset is processed asynchronously. The `Location` header points to the operation that tracks its progress. The `Idempotency-Key` header is required; retrying with the same key returns the same operation.