The OpenDNS Network Devices API Developer Hub

Welcome to the OpenDNS Network Devices API developer hub. You'll find comprehensive guides and documentation to help you start working with OpenDNS Network Devices API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Destinations: Top Identities

The top identities for a destination endpoint lists the top 10 identities in your organization that have made a DNS request to the destination specified in the query.

This query requires your orgid and a destination.

The destination must a domain specified without any protocol or delimiters (such as a trailing backslash).

Example query:

curl -i -X GET --url https://reports.api.umbrella.com/v1/organizations/{orgId}/destinations/{destination}/identities --header 'Authorization: Basic %base64string%'

Example response:

GET https://reports.api.umbrella.com/v1/organizations/{orgId}/destinations/{destination}/identities
REQUEST
curl --include \
     --header "Authorization: Basic %base64string%" \
https://reports.api.umbrella.com/v1/organizations/{orgId}/destinations/{destination}/identities
    
RESPONSE (HTTP 200, Content-Type: application/json)
{
    "identities": [
        {
            "rank": 1,
            "originLabel": "The Corporate Network",
            "originType": "network",
            "originId": 87414500,
            "numberOfRequests": 2
        },
        {
            "rank": 2,
            "originLabel": "San Francisco",
            "originType": "site",
            "originId": 9188997,
            "numberOfRequests": 2
        },
        {
            "rank": 3,
            "originLabel": "The Branch location",
            "originType": "network",
            "originId": 81185341,
            "numberOfRequests": 2
        }
    ]
}
    

Returned Value For Output If Success 200

Field
Type
Description

rank

integer

the order of this identity in the rank of top 10 identities querying the specified destination.

originLabel

string

the name or label of the identity, should match the one given in the dashboard.

originType

string

the identity type matching that seen in the dashboard. Network, Roaming Computer or Site are common types.

originId

integer

the numerical identifier for the individual identity, can be used in conjunction with other queries.

numberOfRequests

integer

number of DNS requests made to the specified destination.

Updated 5 months ago

Destinations: Top Identities


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.