1 of 20
2 of 20
3 of 20
4 of 20
5 of 20
6 of 20
7 of 20
8 of 20
9 of 20
10 of 20
11 of 20
12 of 20
13 of 20
14 of 20
15 of 20
16 of 20
17 of 20
18 of 20
19 of 20
20 of 20

site

doc

blog

success stories

Intelligent DNS

Edit on GitHub

Use the Intelligent DNS API to create, query, update and delete your Hosted Zones and Records.

  1. Retrieving the list of Hosted Zones
  2. Retrieving data from a Hosted Zone
  3. Creating a new Hosted Zone
  4. Editing a Hosted Zone
  5. Deleting a Hosted Zone
  6. Retrieving list of Records per Hosted Zones
  7. Creating a new Record
  8. Editing a Record
  9. Deleting a Record

1. Retrieving the list of Hosted Zones

It returns the list of Hosted Zones.

GET /intelligent_dns

Required permission: View Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3

Request Example

GET /intelligent_dns 
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f22

Response Example

{
    "count": 2,
    "total_pages": 1,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": null
    },
    "results": [
        {
            "is_active": true,
            "domain": "mydomain.com",
            "name": "Domain Criado via API",
            "id": 1
        },
        {
            "is_active": true,
            "domain": "domain.com",
            "name": "Domain Criado via RTM",
            "id": 2
        }
    ]
}

2. Retrieving data from a Hosted Zone

It returns the details of a Hosted Zone.

GET /intelligent_dns/:id

Required permission: View Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
:id
*required
ID of the hosted zone to be queried. path number

Request Example

GET /intelligent_dns/111
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5942

Response Example

{
    "results": {
        "expiry": 1209600,
        "id": 111,
        "is_active": true,
        "domain": "mydomain.com",
        "name": "Hosted Zone criado pela API",
        "nameservers": [
            "ns1.aziondns.net",
            "ns2.aziondns.com"
        ],
        "nx_ttl": 3600,
        "refresh": 43200,
        "retry": 7200,
        "soa_ttl": 3600
    },
    "schema_version": 3
}

3. Creating a new Hosted Zone

It enables you to create a new Hosted Zone.

POST /intelligent_dns

Required permission: Edit Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
Content-Type
*required
The type of encoding used in Body (application/json).

Example:
Content-Type: application/json
header string

Request Example

POST /intelligent_dns
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
    "name": "Hosted Zone criado pela API",
    "domain": "meudomain.com",
    "is_active": true
}

Response Example

{
    "results": {
        "domain": "meudomain.com",
        "expiry": 1209600,
        "id": 1,
        "is_active": true,
        "name": "Hosted Zone criado pela API",
        "nameservers": [
            "ns1.aziondns.net",
            "ns2.aziondns.com"
        ],
        "nx_ttl": 3600,
        "refresh": 43200,
        "retry": 7200,
        "soa_ttl": 3600
    },
    "schema_version": 3
}

4. Editing a Hosted Zone

It enables you to modify a Hosted Zone that has already been created.

PUT /intelligent_dns/:zone_id

Required permission: Edit Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
Content-Type
*required
The type of encoding used in Body (application/json).

Example:
Content-Type: application/json
header string
:zone_id
*required
ID of a previously created Hosted Zone. path number

Request Example

PUT /intelligent_dns/111
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
    "name": "Hosted Zone Editada pela API",
    "domain": "mydomain.com",
    "is_active": true
}

Response Example

{
    "results": {
        "domain": "mydomain.com",
        "expiry": 1209600,
        "id": 111,
        "is_active": true,
        "name": "Hosted Zone Editada pela API",
        "nameservers": [
            "ns1.aziondns.net",
            "ns2.aziondns.com"
        ],
        "nx_ttl": 3600,
        "refresh": 43200,
        "retry": 7200,
        "soa_ttl": 3600
    },
    "schema_version": 3
}

5. Deleting a Hosted Zone

It enables you to delete a Hosted Zone that has already been created.

DELETE /intelligent_dns/:zone_id

Required permission: Edit Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
:zone_id
*required
ID of a previously created Hosted Zone. path number

Request Example

DELETE /intelligent_dns/111/records/333
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Response Example

HTTP/2 204

6. Retrieving list of Records per Hosted Zones

It returns the Records’ list of Hosted Zones.

GET /intelligent_dns/:id/records

Required permission: View Intelligent DNS

Mandatory parameters

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
:id
*required
ID of the hosted zone to be queried. path number

Request Example

GET /intelligent_dns/111/records
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5942

Response Example

{
   "count": 1,
   "links": {
       "previous": null,
       "next": null
   },
   "total_pages": 1,
   "schema_version": 3,
   "results": {
       "records": [
           {
               "record_type": "ANAME",
               "ttl": 3600,
               "answers_list": [
                   "123456a.ha.azioncdn.net"
               ],
               "entry": "@",
               "policy": "simple",
               "description": ""
           }
       ],
       "zone_id": 111,
       "zone_domain": "meudomain.com"
   }
}

7. Creating a new Record

It enables the creation of a Record linked to a Hosted Zone.

POST /intelligent_dns/:zone_id/records

Required permission: Edit Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
Content-Type
*required
The type of encoding used in Body (application/json).

Example:
Content-Type: application/json
header string
:zone_id
*required
ID of the hosted zone to be queried. path number

Request Example

POST /intelligent_dns/111/records
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
    "record_type": "ANAME",
    "entry": "@",
    "answers_list": [
        "123456a.ha.azioncdn.net"
    ],
    "ttl": 20,
    "policy": "simple"
}

Response Example

{
   "results": {
       "zone_id": 111,
       "id": 333,
       "record_type": "ANAME",
       "entry": "@"
       "answers_list": [
           "123456a.ha.azioncdn.net"
       ],
       "ttl": 20,
       "policy": "simple",
       "description": "",
   },
   "schema_version": 3
}

8 - Editing a Record

It enables you to modify a Record that has already been created.

PUT /intelligent_dns/:zone_id/records/:record_id

Required permission: Edit Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
Content-Type
*required
The type of encoding used in Body (application/json).

Example:
Content-Type: application/json
header string
:zone_id
*required
ID of the hosted zone to be queried. path number
:record_id
*required
ID of a previously created Record. path number

Request Example

PUT /intelligent_dns/111/records/333
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
    "record_type": "CNAME",
    "entry": "www",
    "answers_list": [
        "123456a.ha.azioncdn.net"
    ],
    "ttl": 3600,
    "policy": "weighted",
    "weight": 60,
    "description": "Florida Load Balancer"
}

Response Example

{
   "results": {
       "zone_id": 111,
       "id": 333,       
       "record_type": "CNAME",
       "entry": "www"
       "answers_list": [
           "123456a.ha.azioncdn.net"
       ],
       "ttl": 3600,
       "policy": "weighted",
       "weight": 60,
       "description": "Florida Load Balancer"
   },
   "schema_version": 3
}

Note: the “weight” value will only be used if the chosen policy is “weighted”. In the case of a “simple” policy, this value will be ignored.

9. Deleting a Record

It enables you to delete a Record linked to a Hosted Zone already created.

DELETE /intelligent_dns/:zone_id/records/:record_id

Required permission: Edit Intelligent DNS

Parameter Description Type Type of Data
Authorization
*required
Token authentication previously created through the Token Creation endpoint header string
Accept
*required
Information about the return type and version header string;

mandatory: application/json;version=3
Content-Type
*required
The type of encoding used in Body (application/json).

Example:
Content-Type: application/json
header string
:zone_id
*required
ID of the hosted zone to be queried. path number
:record_id
*required
ID of a previously created Record. path number

Request Example

DELETE /intelligent_dns/111/records/333
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Response Example

HTTP/2 204

Didn’t find what you were looking for? Open a ticket.