Software Secure Workload
Activity Configure

API to Return a Troubleshooting Command

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

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

where <id> is the id that can be obtained from the API to Get Connectors, <command_id> is the id that can be obtained from API to List Troubleshooting Commands.

Parameters: The request URL contains the following parameters

Name

Type

Description

id

string

Specify the Connector ID

command_id

string

Specify the command ID

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

Sample response

resp = restclient.get('/connectors/63db5418e6ee1167a4c0986c/commands/63db593df029813659f9fcf6')
  if resp.status_code == 200:
    parsed_resp = json.loads(resp.content)
    print json.dumps(parsed_resp)

Sample response

{
    "appliance_id": "63dad690e6ee1131f255e985",
    "connector_id": "63db5418e6ee1167a4c0986c",
    "service_id": "63db5418e6ee1167a4c0986d",
    "state": "success",
    "level": "SERVICE",
    "command": "SHOW_LOG",
    "arg_string": "",
    "args": {
      "pattern": "info"
    },
    "tailed": false,
    "rc": 0,
    "push_to_dio_at": 1675319615,
    "attempts": 1,
    "error_code": "NO_ERROR",
    "error_text": "",
    "deleted": false,
    "deleted_at": 0,
    "created_at": 1675319613,
    "total_chunk": 0,
    "id": "63db593df029813659f9fcf6"
  }