Skip to main content
Version: 2023.3

Execution Stop

Description

Ends an execution of a component or sandbox command, per specified execution ID. Returns a successful response when the execution is stopped.

URL

http://{CloudShell Sandbox API Gateway IP address}:{port#}/api/v2/executions/{execution_id}

ParameterDescription/Comments
execution_idThe id of the command's execution (string). Can be retrieved via the component command start and the sandbox command start methods.

HTTP method

DELETE

Request

Headers

Example header format for the execution 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 execution stop method ends the execution:

{
"result": "success",
}