Software Secure Workload
Activity Configure

API to Get the Configs on Connector Config Type

This endpoint gets the configs of the Connector with given ID.

GET /openapi/v1/connectors/<id>/config?config_type=<config_type>

where <id> is the id that can be obtained from the API to Get List of Appliances. <config_type> is the "valid_config" that can be obtained from API to Get Appliance Schema.

Parameters: The request URL contains the following parameters

Name

Type

Description

id

string

Specify the Connector ID

config_type

string

Specify the config type. Refer to API to Get the Schema of Config for all possible values listed under Description

Response object: Returns the configs with given Connector ID and config type.

Sample response

resp = restclient.get('/connectors/63db5418e6ee1167a4c0986c/config?config_type=LOG')
  if resp.status_code == 200:
    parsed_resp = json.loads(resp.content)
    print json.dumps(parsed_resp)

Sample response

 [{
    "mode": "TEST_AND_APPLY",
    "name": "Log instance 2/1/23 22:29",
    "root_scope_id": "63d98f45497d4f53005b24fa",
    "vrf_id": 1,
    "appliance_id": "63dad690e6ee1131f255e985",
    "connector_id": "63db5418e6ee1167a4c0986c",
    "service_id": "63db5418e6ee1167a4c0986d",
    "deleted": false,
    "type": "LOG",
    "state": "COMMIT",
    "error_code": "NO_ERROR",
    "error_text": "",
    "attempts": 1,
    "config": {
      "secured": {},
      "unsecured": {
        "log-level": "info",
        "max-log-size": 10,
        "max-log-age": 30,
        "max-log-backups": 20
      }
    },
    "push_to_dio_at": 1675319360,
    "created_at": 1675319360,
    "updated_at": 1675319364,
    "discovery_completed_at": 0,
    "committed_at": 1675319364,
    "delete_at": 0,
    "error_at": 0,
    "hidden": false,
    "discovery_phase": 0,
    "internal": false,
    "id": "63db5840f029813659f9fcf5"
  }]