Component Command Name

Description

Gets details about a particular command for a specific component (resource, service, or App) in a sandbox.

URL

http://{CloudShell Sandbox API Gateway IP address}:{port#}/api/v2/sandboxes/{sandbox_identifier}/components/{component_id}/commands/{command_name}

Parameter	Description/Comments
sandbox_identifier	The id of the sandbox (string). Can be retrieved via sandboxes, blueprint start and from the sandbox ID segment in the CloudShell Portal URL.
component_id	The id of the component (string). Can be retrieved via sandbox components and blueprint start.
command_name	The name of the command (string). Can be retrieved via sandbox component commands.

HTTP method

GET

Request

Headers

Example header format for the component command name method:

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

Content-Type: application/json

Response

Response example

The component command name method returns details about a specific component command in a particular sandbox and the actions that can be performed on the command.

{
   "name":"my_command",
   "description":"",
   "params":[
      {
         "name":"param1",
         "description":"",
         "type":"numeric""possible values":[
            
         ],
         "default value":"""mandatory":false
      }
   ]"executions":[
      {
         "id":"0daead01-8e57-4064-81d4-84911effa911",
         "status":"Pending",
         "supports_Cancelation":"false",
         "_links":{
            "self":{
               "href":"/executions/0daead01-8e57-4064-81d4-84911effa911",
               "method":"GET"
            }"stop":{
               "href":"/executions/0daead01-8e57-4064-81d4-84911effa911",
               "method":"DELETE"
            }
         }
      }
   ],
   "_links":{
      "self":{
         "href":"/sandboxes/0daead01-8e57-4064-81d4-84911effa000/components/0daead01-8e57-4064-81d4-84911effa933/commands/my-command",
         "method":"GET"
      },
      "start":{
         "href":"/sandboxes/0daead01-8e57-4064-81d4-84911effa000/components/0daead01-8e57-4064-81d4-84911effa933/commands/my-command/start",
         "method":"POST"
      }
   }
}

Response summary

The response output properties of the component command name method are described in the following table.

Property	Sub Property	Description/Comments
name		The name of the command. (string)
description		A short description of the command. (string)
params		The parameters needed for the command execution. (array)
	name	The parameter name. (string)
	description	The parameter description. (string)
	type	The parameter type ("string", "numeric", or "lookup"). (string)
	possible values	All the possible values for this parameter. (array)
	default value	The default value of the parameter. (string)
	mandatory	Whether or not the parameter is mandatory for the command execution. (bool)
executions		The execution history for this command. (array)
	id	The ID of the execution. (string)
	status	The current status of the command execution ("pending", "running", "stopping", "canceled", (string)
	supports_cancellation	Whether or not stopping the execution before it is completed is supported. (bool)
	_links	The actions that can be performed on the execution (Get execution details, Delete execution)
_links		The actions that can be performed on the sandbox's component command in the user's domain:
	self	Provides a link to get the command's details via a GET request.
	start	Provides a link to get start the command's execution via a POST request.
command_tag	string	(For connected commands only) Tag defined for the command. Options are "power" or "remote_(remote command name)"