Reset the sandbox
/sandbox/resetsDeletes 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 production_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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/sandbox/resets" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "attempt": { "number": 0, "status": "running" }, "cancellation_requested": true, "created_at": "2019-08-24T14:15:22Z", "error": {}, "expires_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "items_url": "string", "object": "operation", "progress": { "done": 0, "failed": 0, "total": 0 }, "result_url": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "type": "string" }}Retrieve the sandbox GET
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.
List test scenarios GET
Returns the complete catalog of sandbox test scenarios in a single response while preserving the standard collection response format. The catalog is the same for production and sandbox credentials.