API to Get the Connector Info with Details

This endpoint gets the Connector info with details.

GET /openapi/v1/connectors/cards/<type>?root_scope_id=<root_scope_id>

where <root_scope_id> is the root_scope_id that can be obtained from the Get scopes API. In request payload, <type> is a string to decide Connector type.

Parameters: The request URL contains the following parameters

Response object: Returns the Connectors under given scope.

Sample response

resp = restclient.get('/connectors/cards/NETFLOW?root_scope_id=63bf8d2f497d4f7287dbd335')
  if resp.status_code == 200:
    parsed_resp = json.loads(resp.content)
    print json.dumps(parsed_resp)

Sample response

{
    "type": "NETFLOW",
    "name": "NetFlow",
    "desc": "Collect telemetry from network devices",
    "long_desc": "Collect NetFlow V9 and/or IPFIX telemetry from network devices such as routers and switches.",
    "group": "Flow Ingest",
    "index": 0,
    "appliance_type": "tetration_data_ingest",
    "state": "disabled",
    "limit_per_appliance": 3,
    "limit_per_rootscope": 10,
    "limit_per_cluster": 100,
    "config": [
      "LOG",
      "ALERT"
    ],
    "max_instances": 0,
    "noteworthy": false,
    "hidden": false,
    "capabilities": [
      "Flow Visibility"
    ],
    "connector_count": 0,
    "info": {
      "help": "NetFlow connector collects telemetry data from various network devices (such as routers, switches).<br> It supports ingest of telemetry data in IPFIX and NetFlow V9 protocols. This connector can be used to discover inventory as it provides a network context. The connector helps convert data from flow exports and send them securely as Tetration Flow records into an instance of Tetration. <br><br><b> Connector Alerts: </b><br> When Connector Alerts are enabled, you may receive the following alerts: <br> &nbsp; 1. NetFlow Connector is down (due to missing heartbeats). <br> &nbsp; 2. Informational alert on high CPU/Memory usage."
    },
    "group_order": 0
  }