Skip to main content
Version: 2023.3

Sandbox Stop

Description

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

URL

http://{CloudShell Sandbox API Gateway IP address}:{port#}/api/v1/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"
}
}
}