Skip to main content
Version: 2023.3

Execution Id

Description​

Gets details about a specific execution of a sandbox or component command, per specified execution ID.

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​

GET

Request​

Headers

Example header format for the execution id method:

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

Content-Type: application/json

Response​

Response example

The execution id method returns details about a specific execution of a sandbox or component command and the actions that can be performed on the execution.

{
   "id":"1DEB29BF-22B0-4CF6-B7BE-02173520EB81",
   "supports_cancellation":"true",
   "started":"""ended":"",
   "status":"",
   "output":"",
   "_links":{
      "self":{
         "href":"/executions/1DEB29BF-22B0-4CF6-B7BE-02173520EB81",
         "method":"GET"
      },
      "stop":{
         "href":"/executions/1DEB29BF-22B0-4CF6-B7BE-02173520EB81",
         "method":"DELETE"
      }
   }
}
Response summary

The response output properties of the execution id method are described in the following table.

PropertySub PropertyDescription/Comments
id The ID of the execution. (string)
supports_cancellation Whether or not stopping the execution before it is completed is supported. (bool)
started The date and time at which the execution started. (string)
ended The date and time at which the execution ended. (string)
status The current status of the command execution - "pending", "running", "stopping", "canceled". (string)
output (If the command returns an output message) The command's output. (string)
_links The actions that can be performed on the execution:
 selfProvides a link to get the execution's details via a GET request.
 stop(If the execution supports cancellation and is still running) Provides a link to end the execution via a DELETE request.