Stop the sandbox
Commits any changes and stops the sandbox without waiting for it to go idle. The response returns the App after the sandbox stops.
If a later request needs the sandbox before the stop finishes, the sandbox keeps running, and the response returns the App as it is. The next request that needs the sandbox starts it again.
Authorizations
Scopes
Headers
A key that identifies this request for retries, up to 200 printable characters. A retry with the same key and input returns the first request's result instead of repeating the work. If you omit the key, the API generates one and returns it in the Idempotency-Key response header.
1 - 200Path Parameters
Response
The App.
The sandbox's state. Any request that needs the sandbox starts it, and the sandbox stops on its own when it's idle.
stopped: the sandbox isn't running.starting: the sandbox is starting.running: the sandbox is running.stopping: the sandbox is committing changes and stopping.failed: the most recent start failed. The API retries while the sandbox is needed, and any request that needs the sandbox retries right away.
stopped, starting, running, stopping, failed