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    

Retrieve all devices or a single device for the current organization

GET /v1/organizations/{organizationId}/networkdevices

After at least one network device has been created, you can obtain a list of all current devices created for an organization. This endpoint returns an array of all devices for your organization.

The response of the API contains the ‘originID’ field that is the assigned asset number in Umbrella. This is required in order to update or delete this network device and is required for additional sets of queries.

Request Parameters

The organization's "organizationID" must be specified in the query string.

Sample query:

curl -i -X GET --url "https://management.api.umbrella.com/v1/organizations/<organizationId>/networkdevices/" --header 'Authorization: Basic %base64string%'

In the response, an originID parameter for each device is listed. In order to retrieve details of a specific device, add the 'originID' to the query path. The information returned will refer to that device only.

Sample query:

curl -i -X GET --url "https://management.api.umbrella.com/v1/organizations/<organizationId>/networkdevices/<originId>" --header 'Authorization: Basic %base64string%'

Responses

Success

Example return for network device read success - HTTP 200

GET https://management.api.umbrella.com/v1/organizations /{organizationID}/networkdevices/
REQUEST
curl --include \
     --header "Authorization: Basic %base64string%" \
https://management.api.umbrella.com/v1/organizations/{organizationID}/networkdevices/
    
RESPONSE (HTTP 200, Content-Type: application/json)
[
  {
    "originId": 35872943,
    "deviceId": "0123456789abcdef",
    "deviceKey": "ModelName-0123456789ab",
    "name": "Your Device Name",
    "serialNumber": "12345a",
    "createdAt": {},
    "organizationId": 1234
  }
  {
    "originId": 35872944,
    "deviceId": "0123461234abcdef",
    "deviceKey": "ModelName-0123461234ab",
    "name": "Your Device Name 2",
    "serialNumber": "67890a",
    "createdAt": {},
    "organizationId": 1234
  }
]
    

Updated 2 years ago

Retrieve all devices or a single device for the current organization


Suggested Edits are limited on API Reference Pages

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