API to Create a Connector
This endpoint creates a Connector for given Appliance.
POST /openapi/v1/connectors
In request payload, <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.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
name |
string |
Specify the name |
|
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” |
|
version |
string |
Specify the version |
Response object: Returns the created connector.
Sample response
req_payload = {
"root_scope_id": "63c41ff2497d4f5f5be73662",
"appliance_id": "63c6ef42bca44e2b5e729191",
"type": "NETFLOW",
"name": "netflowtest",
"version": "1.1.1"
}
resp = restclient.post('/connectors', json_body=json.dumps(req_payload))
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
{
"name": "netflowtest",
"updated_at": 0,
"created_at": 1674187875,
"appliance_id": "63c6ef42bca44e2b5e729191",
"root_scope_id": "63c41ff2497d4f5f5be73662",
"vrf_id": 1,
"type": "NETFLOW",
"ip_bindings": [],
"sources": [],
"internal": false,
"id": "63ca14631a49bd4c0e0cefa2"
}