Software Secure Workload
Activity Configure

API to Return a Troubleshooting Command

This endpoint returns the selected troubleshooting command for a given Appliance.

GET /openapi/v1/ext_appliances/<id>/commands/<command_id>

where <id> is the appliance_id that is obtained from the API to Get List of Appliances, <command_id> is the id that is obtained from API to List Troubleshooting Commands.

Parameters: The request URL contains the following parameters

Name

Type

Description

id

string

Specify the Appliance ID

command_id

string

Specify the command ID

Response object: Returns the selected troubleshooting command for a given Appliance.

Sample response

resp = restclient.get('/ext_appliances/63be3b1ade36423c12bff6e1/commands/63c10fd139042a1c0ddd3e1f')
  if resp.status_code == 200:
    parsed_resp = json.loads(resp.content)
    print json.dumps(parsed_resp)

Sample response

{
    "appliance_id": "63be3b1ade36423c12bff6e1",
    "state": "pending",
    "level": "APPLIANCE",
    "command": "SHOW_LOG",
    "arg_string": "",
    "args": {},
    "tailed": false,
    "rc": 0,
    "push_to_dio_at": 0,
    "attempts": 0,
    "deleted": false,
    "deleted_at": 0,
    "created_at": 1673596881,
    "total_chunk": 0,
    "id": "63c10fd139042a1c0ddd3e1f"
  }