API to Get Connectors
This endpoint returns all Connectors for a given Appliance.
GET /openapi/v1/connectors?root_scope_id=<root_scope_id>&appliance_id=<appliance_id>&type=<type>&state=<state>
where <root_scope_id> is the root_scope_id that can be obtained from the Get scopes API, <appliance_id> is the appliance_id that can be obtained from API to Get List of Appliances, <type> is a string to decide Connector type that can be obtained from API to Get Appliance Schema "connectors" field, <state> is a filter for connectors state.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
root_scope_id |
string |
Specify the root scope |
|
appliance_id |
string |
Specify the Appliance ID |
|
type |
string |
Specify the Connector type, the value can be either “NETFLOW”, “NETSCALER” “F5” “AWS” “ANYCONNECT” “ASA” “SLACK” “KINESIS” “SYSLOG” “EMAIL” “MERAKI” “PAGERDUTY” “ISE” “SERVICENOW” “ERSPAN” “AWS_CONNECTOR” “AZURE_CONNECTOR” “GCP_CONNECTOR” |
|
state |
string |
Filter the Connectors state, the value can be either “ENABLED” “DISABLED” or “UNAVAILABLE” |
Response object: Returns all Connectors for given Appliance.
Sample response
resp = restclient.get('root_scope_id=63bf8d2f497d4f7287dbd335&appliance_id=63c1272039042a1c0ddd3e20&type=ERSPAN&state=ENABLED')
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
[
{
"name": "ERSPAN",
"updated_at": 0,
"created_at": 1673604657,
"appliance_id": "63c1272039042a1c0ddd3e20",
"root_scope_id": "63bf8d2f497d4f7287dbd335",
"vrf_id": 1,
"type": "ERSPAN",
"ip_bindings": [],
"state": "enabled",
"internal": false,
"id": "63c12e316419d0131767e21b"
},
{
"name": "ERSPAN",
"updated_at": 0,
"created_at": 1673604657,
"appliance_id": "63c1272039042a1c0ddd3e20",
"root_scope_id": "63bf8d2f497d4f7287dbd335",
"vrf_id": 1,
"type": "ERSPAN",
"ip_bindings": [],
"state": "enabled",
"internal": false,
"id": "63c12e316419d0131767e21c"
},
{
"name": "ERSPAN",
"updated_at": 0,
"created_at": 1673604657,
"appliance_id": "63c1272039042a1c0ddd3e20",
"root_scope_id": "63bf8d2f497d4f7287dbd335",
"vrf_id": 1,
"type": "ERSPAN",
"ip_bindings": [],
"state": "enabled",
"internal": false,
"id": "63c12e316419d0131767e21d"
}
]