API documentation - BlueCat DNS Edge

The following outlines all APIs that can be used to interact with the DNS Edge Cloud, including API methods, input parameters, and expected responses.

Admin and analyst roles and API access

DNS Edge users with Admin accounts can access all of the APIs. Users with Analyst accounts can access GET APIs, and the change and reset password APIs.

Sending API requests

When working with APIs related to the DNS Edge Cloud or Service Point v3, send API requests to your DNS Edge instance with api- before the instance URL. For example:

https://api-myDNSedge.com/v1/api/authentication/token

When working with APIs related to Service Point v4, send API requests to the us.fleet.bluec.at Fleet Management endpoint URL. For example:

https://us.fleet.bluec.at/user/api/v1/servicePoints

Attention:

The us.fleet.bluec.at endpoint URL is applicable to all DNS Edge instance and not tied to a specific customer instance URL.
The us.fleet.bluec.at endpoint URL is currently only available for customers running DNS Edge environments based in the United States.

Getting an authentication token

Most of the DNS Edge APIs require an authorization token in the request header. Before logging into the DNS Edge API, you must generate your API access key set from your profile page in the DNS Edge UI. The client ID and secret access key are required to obtain the API token for your user profile. For more information, refer to Profile.

Attention: Any API access key set created before activating or deactivating the SSO integration won't be valid in the new SSO state. You must create a new API access key set in the new SSO state to continue to use the DNS Edge API. If you deactivate or activate the SSO integration again, you can use the API access key set that was previously created.

To get a token, post the following authentication request and copy the accessToken from the response. This will be used as the Authorization Bearer token in any API that requires authorization.

Request: POST https://api-<DNS.edge.url>/v1/api/authentication/token
{
   "grantType": "ClientCredentials",
   "clientCredentials": {
      "clientId": "<clientId>",
      "clientSecret": "<clientSecret>"
   }
}

For example

Request: POST https://api-<DNS.edge.url>/v1/api/authentication/token
{
   "grantType": "ClientCredentials",
   "clientCredentials": {
      "clientId": "f0299f8e-8f60-4f9a-b1fe-8b511f1e0e36",
      "clientSecret": "b99d4f19-86d4-49ce-8744-8e3486f11e09"
   }
}

The token expires after five minutes. You can log in again.

See /v1/api/authentication/token (POST) for details.