Reset a sandbox
A reset empties a sandbox so you can start over. Its data is deleted, while its API keys and webhook endpoints keep working. Owners and developers can reset a sandbox. The live environment can never be reset.
What a reset deletes and keeps
| Deleted | Kept |
|---|---|
| Deposit addresses, deposits, settlements and routings | The sandbox's name, handle and URL |
| Payouts, transfers, balances and wallet addresses | API keys, including their secrets |
| Routing policies and treasuries | Webhook endpoints and their signing secrets |
| Webhook events and delivery history | Your team and workspace settings |
| Simulations and request logs |
After a reset, the sandbox starts with a fresh default routing policy and new vaults with new addresses. Addresses from before the reset are never issued again.
Reset a sandbox
Or open the workspace menu and choose Environments → Manage environments.
On the sandbox row, open Environment actions (the ⋯ button) and choose Reset sandbox.
The dialog counts the records the reset will delete, by type. If you are working in this sandbox right now, it warns you that the dashboard will show an empty world afterwards.
Choose Reset sandbox. The Sandbox reset receipt follows the reset as it runs. When it finishes, choose Done.
While the reset runs
A reset usually takes a moment. While it runs:
- A Resetting banner shows across the sandbox. Its data can't be read, and nothing can be changed.
- API requests with the sandbox's keys are refused with
409 environment resetting. Retry them once the reset finishes. - Simulations still running end as expired.
When the reset finishes, the banner reads "The sandbox reset finished. It starts empty, with its configuration kept."
If part of the reset couldn't finish, the receipt says which part. Reset the sandbox again to finish: the retry picks up the same job.
Webhooks after a reset
Webhook deliveries from the sandbox carry a reset_epoch number that goes up with every reset. Use it to tell events from before a reset apart from events after it. See reset_epoch on the Developers surface.
Unused sandboxes
A sandbox that hasn't been used for 30 days is reset automatically.
For how your integration sees a reset, see Sandbox resets on the Developers surface.