/v1/api/umbrellaIntegrations (GET) - BlueCat DNS Edge

DNS Edge User Guide

prodname
BlueCat DNS Edge

Returns configuration information about the Cisco Umbrella integration

GET https://api-<DNS.Edge.URL>/v1/api/umbrellaIntegrations
Authorization: Bearer authorization token

Response

200 OK
Content-Type: application/JSON
[
  {
    "id": "<id>",
    "name": "<name of integration>",
    "description": "<description>",
    "organizationId": <organization id>,
    "networkDeviceCredentials": {
      "key": "<api key">,
      "updatedAt": "<timestamp of key creation>"
    },
    "createdAt": <timestamp of integration creation>,
    "updatedAt": <timestamp of integration update>,
    "deviceRegistrations": {
      "id": "<id>",
      "scopeId": "<id of the site>",
      "scopeType": "SITE",
      "createdAt": <timestamp of site creation>,
      "umbrellaDevice": {
        "originId": <id of umbrella device>,
        "deviceId": "<device id>",
        "name": "BC Edge - <name of site>",
        "model": "BlueCat_ServicePoint",
        "macAddress": "<mac address>",
        "serialNumber": "<id of the site>",
        "tag": "SITE::<id of the site>"
        }
     }
  },
  ....
]
Successful response code:
  • OK - Successful request
Possible error codes:
  • INTERNAL SERVER ERROR - Unexpected error