Skip to content

Reset the sandbox

Resets the org's sandbox sites: deletes the app's ledger rows and webhook history for those sites.

POST
/v1/sandbox/reset

Resets the org's sandbox sites: deletes the app's ledger rows and webhook history for those sites.

Authorization

AuthorizationBearer <token>

OAuth 2.0 client credentials. private_key_jwt (SMART Backend Services asymmetric) is recommended; client secrets need an IP allowlist or mTLS outside the sandbox.

In: header

Scope: sandbox:write

Header Parameters

Api-Version?enum

Overrides the app's pinned dated version for this request.

Idempotency-Key?string

1–255 characters of [A-Za-z0-9._:-] (a UUID v4 is recommended); never PHI. Stored 24 hours per app.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/sandbox/reset" \  -H "Content-Type: application/json" \  -d '{}'
{  "object": "sandbox_reset",  "sites": [    "kb-main-ed"  ]}

Was this page helpful?