Learn more:

• Edge DNS

• Fast DNS Traffic Reporting API

• Akamai CLI for Edge DNS (formerly Fast DNS)

Overview

This API has been deprecated. Use the Edge DNS Zone Management API instead.

Welcome to Akamai’s Enhanced DNS service. Enhanced DNS is designed to integrate easily with your existing DNS infrastructure to provide a secure, high performance, highly available and scalable solution for DNS hosting. As part of this service, Akamai runs name servers in multiple networks and in many geographic locations that are capable of resolving queries for your zones. Akamai’s IP Anycast technology is also capable of providing an unprecedented level of reliability and performance for name resolution.

The Enhanced DNS service supports two types of Zones:

• Primary: Akamai will serve the DNS records of your zones without the need for master DNS servers maintained by you.

• Secondary: Akamai will serve the DNS records of your zones obtained by performing secured zone transfers from your master name server.

This API focuses on primary zones, specifically the management of DNS records of an existing primary zone.

Record management

Once a primary Enhanced DNS zone is provisioned in Akamai Control Center, a nonbrowser-based client may invoke this API to manage the DNS records of the Zone. To update a zone configuration,

1. Retrieve the current zone configuration (GET /config-dns/v1/zones/{zone}).

2. Increment the SOA record’s serial field.

3. Add new records, remove old ones and update existing records in the Zone configuration as needed.

4. Submit the full zone configuration (POST /config-dns/v1/zones/{zone}).

Example: modifying an existing zone record set configuration

Consider the most basic Zone configuration for example.com: a Zone with a single SOA record and two NS records:

example.com.            900     IN      SOA     use4.akamai.com. hostmaster.akamai.com. 1271354824 900 300 604800 180
example.com.            3600    IN      NS      use4.akam.net.
example.com.            3600    IN      NS      use3.akam.net.

Our task will be to add a new A Record with the name www, and an IP address 1.2.3.4:

GET /config-dns/v1/zones/example.com
{
    "token": "a184671d5307a388180fbf7f11dbdf46",
    "zone": {
        "name": "example.com",
        "soa": {
            "contact": "hostmaster.akamai.com.",
            "expire": 604800,
            "minimum": 180,
            "originserver": "use4.akamai.com.",
            "refresh": 900,
            "retry": 300,
            "serial": 1271354824,
            "ttl": 900
        },
        "ns": [
            {
                "active": true,
                "name": "",
                "target": "use4.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "",
                "target": "use3.akam.net.",
                "ttl": 3600
            }
        ]
    }
}

Note the token field. It is a unique value calculated for every zone configuration, and must be presented with the Zone submission, which is used by Control Center to guarantee that the submission modifies the current configuration. This is to prevent inadvertently overwriting another client’s submission.

POST /config-dns/v1/zones/example.com
{
    "token": "a184671d5307a388180fbf7f11dbdf46",
    "zone": {
        "name": "example.com",
        "soa": {
            "contact": "hostmaster.akamai.com.",
            "expire": 604800,
            "minimum": 180,
            "originserver": "use4.akamai.com.",
            "refresh": 900,
            "retry": 300,
            "serial": 1271354825,
            "ttl": 900
        },
        "ns": [
            {
                "active": true,
                "name": "",
                "target": "use4.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "",
                "target": "use3.akam.net.",
                "ttl": 3600
            }
        ],
        "a": [
            {
                "active": true,
                "name": "www",
                "target": "1.2.3.4",
                "ttl": 3600
            }
        ]
    }
}

Example: creating a new zone record set configuration

If a Zone has been created in Control Center, but hasn’t had any records added yet, attempts to retrieve the Zone will result in a 404 return code, as the Zone’s configuration does not exist yet.

To create, the POST request will look the same as modifying an existing Zone, with one exception: the token value must be set to new:

POST /config-dns/v1/zones/example.com
{
    "token": "new",
    "zone": {
        "name": "example.com",
        "soa": {
            "contact": "hostmaster.akamai.com.",
            "expire": 604800,
            "minimum": 180,
            "originserver": "use4.akamai.com.",
            "refresh": 900,
            "retry": 300,
            "serial": 1271354825,
            "ttl": 900
        },
        "ns": [
            {
                "active": true,
                "name": "",
                "target": "use4.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "",
                "target": "use3.akam.net.",
                "ttl": 3600
            }
        ],
        "a": [
            {
                "active": true,
                "name": "www",
                "target": "1.2.3.4",
                "ttl": 3600
            }
        ]
    }
}

Resources

Akamai’s Enhanced DNS product. This API manages records of Enhanced DNS Zones of type primary.

API summary

Get a zone

Returns the complete representation of the zone, which includes all of the records for the specified zone. Additionally, a token is returned, which is required when submitting a modified version of the zone.

NOTE: This resource can return in JSON (application/json) or XML (application/xml) format. Default: JSON.

{
    "token": "a184671d5307a388180fbf7f11dbdf46",
    "zone": {
        "a": [
            {
                "active": true,
                "name": "arecord",
                "target": "1.2.3.5",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "origin",
                "target": "1.2.3.9",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "arecord",
                "target": "1.2.3.4",
                "ttl": 3600
            }
        ],
        "aaaa": [
            {
                "active": true,
                "name": "ipv6record",
                "target": "2001:0db8::ff00:0042:8329",
                "ttl": 3600
            }
        ],
        "afsdb": [
            {
                "active": true,
                "name": "afsdb",
                "subtype": 1,
                "target": "example.com.",
                "ttl": 7200
            }
        ],
        "cname": [
            {
                "active": true,
                "name": "redirect",
                "target": "arecord.example.com.",
                "ttl": 3600
            }
        ],
        "dnskey": [
            {
                "active": true,
                "algorithm": 3,
                "flags": 257,
                "key": "Av//0/goGKPtaa28nQvPoUwVQ ... i/0hC+1CrmQkuuKtQt98WObuv7q8iQ==",
                "name": "dnskey",
                "protocol": 7,
                "ttl": 7200
            }
        ],
        "ds": [
            {
                "active": true,
                "algorithm": 7,
                "digest": "909FF0B4DD66F91F56524C4F968D13083BE42380",
                "digest_type": 1,
                "keytag": 30336,
                "name": "ds",
                "ttl": 7200
            }
        ],
        "hinfo": [
            {
                "active": true,
                "hardware": "INTEL-386",
                "name": "hinfo",
                "software": "UNIX",
                "ttl": 7200
            }
        ],
        "id": 11874,
        "loc": [
            {
                "active": true,
                "name": "location",
                "target": "51 30 12.748 N 0 7 39.611 W 0.00m 0.00m 0.00m 0.00m",
                "ttl": 7200
            }
        ],
        "mx": [
            {
                "active": true,
                "name": "four",
                "priority": 10,
                "target": "mx1.akamai.com.",
                "ttl": 7200
            }
        ],
        "name": "example.com",
        "naptr": [
            {
                "active": true,
                "flags": "S",
                "name": "naptrrecord",
                "order": 0,
                "preference": 10,
                "regexp": "!^.*$!sip:customer-service@example.com!",
                "replacement": ".",
                "service": "SIP+D2U",
                "ttl": 3600
            }
        ],
        "ns": [
            {
                "active": true,
                "name": null,
                "target": "use4.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": null,
                "target": "use3.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "five",
                "target": "use4.akam.net.",
                "ttl": 172800
            }
        ],
        "nsec3": [
            {
                "active": true,
                "algorithm": 1,
                "flags": 0,
                "iterations": 1,
                "name": "qdeo8lqu4l81uo67oolpo9h0nv9l13dh",
                "next_hashed_owner_name": "R2NUSMGFSEUHT195P59KOU2AI30JR96P",
                "salt": "EBD1E0942543A01B",
                "ttl": 7200,
                "type_bitmaps": "CNAME RRSIG"
            }
        ],
        "nsec3param": [
            {
                "active": true,
                "algorithm": 1,
                "flags": 0,
                "iterations": 1,
                "name": "qnsec3param",
                "salt": "EBD1E0942543A01B",
                "ttl": 7200
            }
        ],
        "ptr": [
            {
                "active": true,
                "name": "ptr",
                "target": "ptr.example.com.",
                "ttl": 7200
            }
        ],
        "rp": [
            {
                "active": true,
                "mailbox": "admin.example.com.",
                "name": "rp",
                "ttl": 7200,
                "txt": "txt.example.com."
            }
        ],
        "rrsig": [
            {
                "active": true,
                "algorithm": 7,
                "expiration": "20120318104101",
                "inception": "20120315094101",
                "keytag": 63761,
                "labels": 3,
                "name": "arecord",
                "original_ttl": 3600,
                "signature": "toCy19QnAb86vRlQjf5 ... z1doJdHEr8PiI+Is9Eafxh+4Idcw8Ysv",
                "signer": "example.com.",
                "ttl": 7200,
                "type_covered": "A"
            }
        ],
        "soa": {
            "contact": "hostmaster.akamai.com.",
            "expire": 604800,
            "minimum": 180,
            "originserver": "use4.akamai.com.",
            "refresh": 900,
            "retry": 300,
            "serial": 1271354824,
            "ttl": 900
        },
        "spf": [
            {
                "active": true,
                "name": "spf",
                "target": "v=spf a -all",
                "ttl": 7200
            }
        ],
        "srv": [
            {
                "active": true,
                "name": "srv",
                "port": 522,
                "priority": 10,
                "target": "target.akamai.com.",
                "ttl": 7200,
                "weight": 0
            }
        ],
        "sshfp": [
            {
                "active": true,
                "algorithm": 2,
                "fingerprint": "123456789ABCDEF67890123456789ABCDEF67890",
                "fingerprint_type": 1,
                "name": "host",
                "ttl": 3600
            }
        ]
        "txt": [
            {
                "active": true,
                "name": "text",
                "target": "Hello world!",
                "ttl": 7200
            }
        ]
    }
}

Add or modify a zone

Resource to add or modify zone configuration.

• When modifying a zone, the token provided needs to match the current token for the zone configuration. The token is provided by the GET method for this resource.

• When adding a new zone, set the token value to new.

• The SOA record’s serial number needs to be greater than the existing SOA serial number in Control Center.

NOTE: This resource supports JSON or XML format. Default: JSON.

{
    "token": "a184671d5307a388180fbf7f11dbdf46",
    "zone": {
        "a": [
            {
                "active": true,
                "name": "arecord",
                "target": "1.2.3.5",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "origin",
                "target": "1.2.3.9",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "arecord",
                "target": "1.2.3.4",
                "ttl": 3600
            }
        ],
        "aaaa": [
            {
                "active": true,
                "name": "ipv6record",
                "target": "2001:0db8::ff00:0042:8329",
                "ttl": 3600
            }
        ],
        "afsdb": [
            {
                "active": true,
                "name": "afsdb",
                "subtype": 1,
                "target": "example.com.",
                "ttl": 7200
            }
        ],
        "cname": [
            {
                "active": true,
                "name": "redirect",
                "target": "arecord.example.com.",
                "ttl": 3600
            }
        ],
        "dnskey": [
            {
                "active": true,
                "algorithm": 3,
                "flags": 257,
                "key": "Av//0/goGKPtaa28nQvPoUwVQ ... i/0hC+1CrmQkuuKtQt98WObuv7q8iQ==",
                "name": "dnskey",
                "protocol": 7,
                "ttl": 7200
            }
        ],
        "ds": [
            {
                "active": true,
                "algorithm": 7,
                "digest": "909FF0B4DD66F91F56524C4F968D13083BE42380",
                "digest_type": 1,
                "keytag": 30336,
                "name": "ds",
                "ttl": 7200
            }
        ],
        "hinfo": [
            {
                "active": true,
                "hardware": "INTEL-386",
                "name": "hinfo",
                "software": "UNIX",
                "ttl": 7200
            }
        ],
        "id": 11874,
        "loc": [
            {
                "active": true,
                "name": "location",
                "target": "51 30 12.748 N 0 7 39.611 W 0.00m 0.00m 0.00m 0.00m",
                "ttl": 7200
            }
        ],
        "mx": [
            {
                "active": true,
                "name": "four",
                "priority": 10,
                "target": "mx1.akamai.com.",
                "ttl": 7200
            }
        ],
        "name": "example.com",
        "naptr": [
            {
                "active": true,
                "flags": "S",
                "name": "naptrrecord",
                "order": 0,
                "preference": 10,
                "regexp": "!^.*$!sip:customer-service@example.com!",
                "replacement": ".",
                "service": "SIP+D2U",
                "ttl": 3600
            }
        ],
        "ns": [
            {
                "active": true,
                "name": null,
                "target": "use4.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": null,
                "target": "use3.akam.net.",
                "ttl": 3600
            },
            {
                "active": true,
                "name": "five",
                "target": "use4.akam.net.",
                "ttl": 172800
            }
        ],
        "nsec3": [
            {
                "active": true,
                "algorithm": 1,
                "flags": 0,
                "iterations": 1,
                "name": "qdeo8lqu4l81uo67oolpo9h0nv9l13dh",
                "next_hashed_owner_name": "R2NUSMGFSEUHT195P59KOU2AI30JR96P",
                "salt": "EBD1E0942543A01B",
                "ttl": 7200,
                "type_bitmaps": "CNAME RRSIG"
            }
        ],
        "nsec3param": [
            {
                "active": true,
                "algorithm": 1,
                "flags": 0,
                "iterations": 1,
                "name": "qnsec3param",
                "salt": "EBD1E0942543A01B",
                "ttl": 7200
            }
        ],
        "ptr": [
            {
                "active": true,
                "name": "ptr",
                "target": "ptr.example.com.",
                "ttl": 7200
            }
        ],
        "rp": [
            {
                "active": true,
                "mailbox": "admin.example.com.",
                "name": "rp",
                "ttl": 7200,
                "txt": "txt.example.com."
            }
        ],
        "rrsig": [
            {
                "active": true,
                "algorithm": 7,
                "expiration": "20120318104101",
                "inception": "20120315094101",
                "keytag": 63761,
                "labels": 3,
                "name": "arecord",
                "original_ttl": 3600,
                "signature": "toCy19QnAb86vRlQjf5 ... z1doJdHEr8PiI+Is9Eafxh+4Idcw8Ysv",
                "signer": "example.com.",
                "ttl": 7200,
                "type_covered": "A"
            }
        ],
        "soa": {
            "contact": "hostmaster.akamai.com.",
            "expire": 604800,
            "minimum": 180,
            "originserver": "use4.akamai.com.",
            "refresh": 900,
            "retry": 300,
            "serial": 1271354824,
            "ttl": 900
        },
        "spf": [
            {
                "active": true,
                "name": "spf",
                "target": "v=spf a -all",
                "ttl": 7200
            }
        ],
        "srv": [
            {
                "active": true,
                "name": "srv",
                "port": 522,
                "priority": 10,
                "target": "target.akamai.com.",
                "ttl": 7200,
                "weight": 0
            }
        ],
        "sshfp": [
            {
                "active": true,
                "algorithm": 2,
                "fingerprint": "123456789ABCDEF67890123456789ABCDEF67890",
                "fingerprint_type": 1,
                "name": "host",
                "ttl": 3600
            }
        ]
        "txt": [
            {
                "active": true,
                "name": "text",
                "target": "Hello world!",
                "ttl": 7200
            }
        ]
    }
}

example.com.            900     IN      SOA     use4.akamai.com. hostmaster.akamai.com. 1271354824 900 300 604800 180
example.com.            3600    IN      NS      use4.akam.net.
example.com.            3600    IN      NS      use3.akam.net.
afsdb.example.com.      7200    IN      AFSDB   1 example.com.
arecord.example.com.    3600    IN      A       1.2.3.5
arecord.example.com.    3600    IN      A       1.2.3.4
arecord.example.com.    3600    IN      RRSIG   A 7 3 3600 20120318104101 20120315094101 63761 example.com. toCy19QnAb86vRlQjf5ARG3wQ7CbH4B4wJ5B6OO7C7/1TP0JXUuOcQ5xMs3NLuzwo2VqqRBBQ1ZlmpIhJ9ceGYYpd7IWEIdbyeZo1PqiQc25HfVObGgyks4RVdN3q4mIxHwqzuWzz1doJdHEr8PiI+Is9Eafxh+4Idcw8Ysv
dnskey.example.com.     7200    IN      DNSKEY  257 7 3 Av//0/goGKPtaa28nQvPoUwVQelORVnzzZH/obPaLxWO5cwYjEXQWzkadfO5pxdeydYTFqGQsTd8c/V0UtCLlRzz5ZGU+pMewlpjtz9n3Ea9O4cCoXdcRrTj4wFQbK+h50iI8Cbcog7H76vgfAU9vSIueBwlWFvId9ehPUlbaL6KVBr5WFvHnUwCjVsUIvRwGKVOixFsthMUf+hPSp2Fx8OHvyw9oQ/TR/QEwj3cGpnbGVvtFzLlo4FdsLoktoLNbvsDxetTzCFRG2GvChmzoQ9xwwQOWiSu5THgTHskiuZPZ2x2UAZGPER0P6A6i/0hC+1CrmQkuuKtQt98WObuv7q8iQ==
ds.example.com.         7200    IN      DS      30336 7 1 909FF0B4DD66F91F56524C4F968D13083BE42380
five.example.com.       172800  IN      NS      use4.akam.net.
four.example.com.       7200    IN      MX      10 mx1.akamai.com.
hinfo.example.com.      7200    IN      HINFO   "INTEL-386" "UNIX"
host.example.com.       3600    IN      SSHFP   2 1 123456789ABCDEF67890123456789ABCDEF67890
ipv6record.example.com. 3600    IN      AAAA    2001:db8:0:0:0:ff00:42:8329
location.example.com.   0       IN      LOC     51 30 12.748 N 0 7 39.611 W 0m 0m 0m 0m
naptrrecord.example.com.        3600    IN      NAPTR   0 10 "S" "SIP+D2U" "!^.*$!sip:customer-service@example.com!" .
origin.example.com.     3600    IN      A       1.2.3.9
ptr.example.com.        7200    IN      PTR     ptr.example.com.
qdeo8lqu4l81uo67oolpo9h0nv9l13dh.example.com.   7200    IN      NSEC3   1 0 1 EBD1E0942543A01B R2NUSMGFSEUHT195P59KOU2AI30JR96P CNAME RRSIG
qnsec3param.example.com.        7200    IN      NSEC3PARAM      1 0 1 EBD1E0942543A01B
redirect.example.com.   3600    IN      CNAME   arecord.example.com.
rp.example.com.         7200    IN      RP      admin.example.com. txt.example.com.
spf.example.com.        7200    IN      SPF     "v=spf a -all"
srv.example.com.        7200    IN      SRV     10 0 522 target.akamai.com.
text.example.com.       7200    IN      TXT     "Hello world!"

Data

This section provides details on the API’s data members. The API supports the following record types:

• A
• AAAA
• AFSDB
• CNAME
• HINFO
• LOC
• MX
• NAPTR
• NS
• PTR
• RP
• SOA
• SPF
• SRV
• SSHFP
• TXT

The API also supports the following record types for customers who have enabled DNSSEC support:

• DNSKEY
• DS
• NSEC3
• NSEC3PARAM
• RRSIG

A

Address record. Represents a 32-bit IPv4 address.

AAAA

IPv6 address record. Represents a 128-bit IPv6 address.

AFSDB

AFS database record. Represents the location of database servers of an AFS cell. This record is commonly used by AFS clients to contact AFS cells outside their local domain. A subtype of this record is used by the obsolete DCE/DFS file system.

CNAME

Canonical name record. Represents an alias of one name to another: the DNS lookup will continue by retrying the lookup with the new name.

DNSKEY

DNS Key record, the key record used in DNSSEC. Uses the same format as the KEY record. It requires DNSSEC.

DS

Delegation signer record. The record used to identify the DNSSEC signing key of a delegated zone. It requires DNSSEC.

HINFO

Host Information record. Describes the CPU and OS of a host.

LOC

Location record. Specifies a geographical location associated with a domain name.

MX

Mail exchange record. Maps a domain name to a list of message transfer agents for that domain.

NAPTR

Naming Authority Pointer. Allows regular expression based rewriting of domain names which can then be used as URIs, further domain names to lookups, etc.

NS

Name server record. Delegates a DNS zone to use the given authoritative name servers.

NSEC3

NSEC record version 3. An extension to DNSSEC that allows proof of nonexistence for a name without permitting zonewalking. It requires DNSSEC.

NSEC3PARAM

NSEC3 members, for use with NSEC3. It requires DNSSEC.

PTR

Pointer to a canonical name. Unlike a CNAME, DNS processing does NOT proceed, just the name is returned. The most common use is for implementing reverse DNS lookups.

RP

Responsible person. Information about people responsible for the domain. Usually an email address with the @ replaced by a .

RRSIG

DNSSEC signature. Signature for a DNSSEC-secured record set. Uses the same format as the SIG record. It requires DNSSEC.

SOA

Start of a zone of authority record. Specifies authoritative information about a DNS zone, including the primary name server, the email of the domain administrator, the domain serial number, and several timers relating to refreshing the zone.

SPF

Sender Policy Framework. Specified as part of the SPF protocol as an alternative to of storing SPF data in TXT records. Uses the same format as the earlier TXT record.

SRV

Service locator. Generalized service location record, used for newer protocols instead of creating protocol-specific records such as MX.

SSHFP

SSH Public Key Fingerprint. Resource record for publishing SSH public host key fingerprints in the DNS System, in order to aid in verifying the authenticity of the host.

TXT

Text record. Originally for arbitrary human-readable text in a DNS record. Since the early 1990s, however, this record more often carries machine-readable data.