Skip to main content

Sandbox Stop

Description​

Ends a sandbox per specified sandbox ID. Returns a successful response when the sandbox is stopped.

note

Added in CloudShell 2024.1.0.2603: This method also supports canceling pending (future/scheduled) reservations, not just stopping active sandboxes.

URL​

http://{CloudShell Sandbox API Gateway IP address}:{port#}/api/v2/sandboxes/{sandbox_identifier}/stop

ParameterDescription/Comments
sandbox_identifierThe id of the sandbox (string). Can be retrieved via sandboxes, blueprint start and from the sandbox ID segment in the CloudShell Portal URL.

HTTP method​

POST

Request​

Headers

Example header format for the sandbox stop method:

Authorization: Basic <authorization token returned from the login method>

Content-Type: application/json

Response​

Response example

A successful response is displayed when the sandbox stop method ends the sandbox:

{
   "result":"success",
   "_links":{
      "all":{
         "href":"/sandboxes",
         "method":"GET"
      }
   }
}