API 2.

0
Documentation

6/07/2012

TABLE OF CONTENTS Overview...................................................................................................... 3 Making A Request ......................................................................................... 3 Rate Limiting ................................................................................................. 3 Supported Data Formats ............................................................................... 3 Try it! Getting Started.................................................................................... 3 Authentication .............................................................................................. 4 Common Header Fields ................................................................................. 6
Request Headers ..................................................................................................................................... 6 Response Headers .................................................................................................................................. 6

Data Types & Example Calls .......................................................................... 7 Domain.......................................................................................................... 8 MultiDomain ............................................................................................... 12 SOA Record ................................................................................................. 15 Vanity DNS .................................................................................................. 17 Template ..................................................................................................... 18 ACL .............................................................................................................. 20 Folder .......................................................................................................... 21 Query Usage ................................................................................................ 22 Failover ....................................................................................................... 24 Record ......................................................................................................... 26 Resources & Methods .................................................................................30 Managed Domain ........................................................................................ 30 Managed Records........................................................................................ 31 Template Records........................................................................................ 31 Secondary Domain ...................................................................................... 33 Secondary Records ...................................................................................... 33 Template Records........................................................................................ 34 Query Usage ................................................................................................ 35 Error Reporting ...........................................................................................36 Generic API Error ........................................................................................... 3

REVISION HISTORY 21-May-12 ................................................................................. Initial Release 07-June-12 ..................................................... Data Types & Examples Update

Overview
Making A Request
REST requests can be made via HTTPS or HTTP by using the headers, authentication, data types, and methods specified below. The current endpoint for the API V2.0 is available at http[s]://api.dnsmadeeasy.com/V2.0/

Rate Limiting
To prevent unwanted flooding of the API system, there is a maximum number of requests that can be sent in a given time period. This limit is 150 requests per 5 minute scrolling window. For example, 100 requests could be made in one minute, followed by a 5 minute wait, following by 150 requests. This limit is tracked per API key and all requests count toward this limit. Refer to the x-dnsme-requestLimit and x-dnsme-requestsRemaining header fields for values related to this limit.

Supported Data Formats

The DNS Made Easy API supports both XML and JSON data formats, specified by using the content-type and accept HTTP header fields. If no format is specified, JSON will be used as a default.

Try it! Getting Started

If youd like to make an API request, just follow these steps. Weve provided a sample Perl script that can be used to make requests. Download and install cURL. Make sure that the cURL executable is part of your path. Download and install Perl. Make sure that the Perl executable is part of your path. Download the necessary Perl extensions by running the following commands: perl -MCPAN -e "install Digest::HMAC_SHA1" perl -MCPAN -e "install HTTP::Date"
4

perl -MCPAN -e "install Config::Properties" Download the following DNS Made Easy files and save them into the same location: o dnsmeapi.properties o dnsmeapi.pl Put your API and Secret Keys into the dnsmeapi.properties file, the location of these keys is specified below in the Authentication section. Make requests using the dnsmeapi.pl script as a wrapper around cURL! For example:
perl dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dns/managed/ -H accept:application/xml perl dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dns/managed/example.com -X perl dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/ dns/managed/12345/records -H accept:application/json

cURL accepts the -X option to set the HTTP method used for the request (GET is used if no method is specified). cURL accepts the H option to set HTTP headers for the request.

Authentication
Authentication with the DNS Made Easy API is done using the API and Secret keys, given on a per-account basis. The values for these keys can be found on the Account Information page under the Config menu after you log in. To make an authenticated request, follow these steps: Create the string representation of the current date and time in HTTP format. Example: Sat, 12 Feb 2011 20:59:04 GMT Calculate the hexadecimal HMAC SHA1 hash of that string using your Secret key as the hash key. Example: b3502e6116a324f3cf4a8ed693d78bcee8d8fe3c

 Set the values for the request headers using your API key, the current date and time, and the HMAC hash that you calculated. This example was created using a Secret key of c9b5625f-9834-4ff8-baba-4ed5f32cae55:
o x-dnsme-apiKey:1c1a3c91-4770-4ce7-96f4-54c0eb0e457a o x-dnsme-requestDate:Sat, 12 Feb 2011 20:59:04 GMT o x-dnsme-hmac:b3502e6116a324f3cf4a8ed693d78bcee8d8fe3c

Requests must be sent shortly after these headers are generated. If too much time has passed between when the x-dnsme-requestDate and x-dnsme-hmac strings were created and when the request is received by the DNS Made Easy API servers, then the request will be denied. Requests made with invalid credentials or an invalid x-dnsme-requestDate value will receive an HTTP 403 Forbidden response.

Common Header Fields

The DNS Made Easy API includes several custom HTTP header fields that contain information about the requests and responses that are sent. These headers fields are: Request Header Fields Description The API Key for your account. Refer to the Advanced DNS page after logging in to find the value for this field. Standard HTTP-formatted date. This date is used to protect against falsified requests played back at a future time. HMAC hash of value of the x-dnsmerequestDate field. Refer to the DNS Made Easy REST API Documentation v2.0 authentication section for more details on how to generate this value.

Field name x-dnsme-apiKey

x-dnsme-requestDate

x-dnsme-hmac

Response Header Fields Field name Description x-dnsme-requestId A unique identifier of the request that was sent. Use the value of this header to help identify your request for your own purposes or when contacting DNS Made Easy support. x-dnsme-requestLimit Maximum number of requests that can be sent before the rate limit is exceeded. x-dnsmerequestsRemaining Number of requests remaining before the rate limit is exceeded.

Supported Data Types

The following data types are used for requests and responses with the DNS Made Easy API:

Domain
The domain data type contains information about a domain or hosted zone. The following fields are available

/domain Field Name accountId name nameServer gtdEnabled soaID vanityId transferAclId folderId

Type numeric String List of Strings boolean numeric numeric numeric numeric

Description The identifier for the account The domain name. Name servers associated with the domain Indicator of whether or not this domain uses the Global Traffic Director The ID of a custom SOA record The ID of a vanity DNS configuration The ID of a transfer ACL The ID of a domain folder

Example XML Representation: <domain> <name>myDomain.com</name> <nameServer>ns10.dnsmadeeasy.com</nameServer> <nameServer>ns11.dnsmadeeasy.com</nameServer> <nameServer>ns12.dnsmadeeasy.com</nameServer> <nameServer>ns13.dnsmadeeasy.com</nameServer> <nameServer>ns14.dnsmadeeasy.com</nameServer> <nameServer>ns15.dnsmadeeasy.com</nameServer> <gtdEnabled>true</gtdEnabled> </domain> Example JSON Representation: { "name":"myDomain.com", "nameServer":[ "ns10.dnsmadeeasy.com", 8

"ns11.dnsmadeeasy.com", "ns12.dnsmadeeasy.com", "ns13.dnsmadeeasy.com", "ns14.dnsmadeeasy.com", "ns15.dnsmadeeasy.com" ], "gtdEnabled":true}

Managed DNS GET SINGLE DOMAIN

This call would return configuration information of a single domain including name server assignment and the domain ID. Example Call A single domain with the domain ID:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/999999

Example Output:
{"name":"example.com","id":999999,"gtdEnabled":true,"nameServers":[{"i pv4":"208.94.148.4","fqdn":"ns10.dnsmadeeasy.com","ipv6":"2600:1800:10 ::1"},{"ipv4":"208.80.124.4","fqdn":"ns11.dnsmadeeasy.com","ipv6":"260 0:1801:11::1"},{"ipv4":"208.80.126.4","fqdn":"ns12.dnsmadeeasy.com","i pv6":"2600:1802:12::1"},{"ipv4":"208.80.125.4","fqdn":"ns13.dnsmadeeas y.com","ipv6":"2600:1801:13::1"},{"ipv4":"208.80.127.4","fqdn":"ns14.d nsmadeeasy.com","ipv6":"2600:1802:14::1"},{"ipv4":"208.94.149.4","fqdn ":"ns15.dnsmadeeasy.com","ipv6":"2600:1800:15::1"}],"pendingActionId": 0,"folderId":99999,"created":1326758400000,"delegateNameServers":[],"u pdated":1337121058848}

Example Error: Generic API 404 Error for a badly formulated request.

Managed DNS PUT SINGLE DOMAINS

This call would be used to change configuration of a single domain. Example Call Changing Vanity DNS ID to 9999 for domain ID 999999:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/999999 -X PUT accept:application/json -H content-type:application/json -d '{"vanityId":"9999"}'

Example Error:

{"error":["Invalid domain IDs specified.","Invalid Vanity NS configuration."]}

Either an invalid domain ID or Vanity DNS ID was specified.

Managed DNS POST MULTIPLE DOMAINS

This call would be used to create multiple domains. Example Call:
./dnsmeapi.pl -v https://api.dnsmadeeasy.com/V2.0/dns/managed -X POST accept:application/json -H content-type:application/json -d '{"names":["example01.com"]}'

Example Error:
{"error":["Domain name conflicts with existing zones."]}

The domain name exists within a DNS Made Easy Account already.

Managed DNS DELETE SINGLE DOMAIN

This call would be used to delete a single domain. Example Call A single domain with the domain ID:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/999999 -X DELETE accept:application/json -H content-type:application/json -d '{["999999"]}'

Secondary DNS POST

This call will create domains under secondary DNS management with an assigned IP Set. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/secondary -X POST H content-type:application/json -d '{"names":["example.com","example1.com"],"ipSetId":"99999"}'

Example Output: The created domain IDs

[99999,99991] 10

Secondary DNS PUT

This call will create domains under secondary DNS management with an assigned IP Set. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/secondary -X PUT accept:application/json -H content-type:application/json -d '{"ids":["99999","99991"],"ipSetId":"99999"}'

Secondary DNS DELETE

This call will delete domains under secondary DNS management using the domain ID. Example Call:
./dnsmeapi.pl -v http://api.dnsmadeeasy.com/V2.0/dns/secondary/99999 X DELETE

11

MultiDomain
A collection of domains. This is used to perform an action on any amount of domains at once, such as creation or deletion. In addition to the available fields from Domain, the following fields are also available.

/domains/managed Field Name Type names List of Strings ids List of numbers

Description List of domain names List of domain identifiers

Example XML representation:

<multiDomain> <name>myDomain.com</name> <name>myDomainTwo.com</name> <name>myDomainThree.com</name> </multiDomain> <multiDomain> <id>1234567890</id> <id>1234567891</id> <id>1234567892</id> </multiDomain> Example JSON Representation [{"name":" myDomain.com"},{"name":" myDomainTwo.com"},{"name":" myDomainThree.com"}]

Managed DNS GET MULTIPLE DOMAINS

This call will return all the managed DNS domain in the account including the domain name, domain ID, and additional GTD, folder, and date configured information. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/

Example Output:
12

{"data":[{"name":"example.com","id":999999,"gtdEnabled":false,"pending ActionId":0,"folderId":99999,"created":1336953600000,"updated":1337033 603667},{"name":"example1.com","id":999991,"gtdEnabled":true,"pendingA ctionId":0,"folderId":99999,"created":1326758400000,"updated":13371210 58848},{"name":"example2.com","id":999992,"gtdEnabled":false,"pendingA ctionId":0,"folderId":9999,"created":1331164800000,"updated":133122508 7653},{"name":"example3.com","id":999993,"gtdEnabled":false,"pendingAc tionId":0,"folderId":9999,"created":1334016000000,"updated":1334080916 510}],"page":1,"totalPages":1,"totalRecords":6}

If the account has no domains, an empty request is returned: { }

Managed DNS PUT MULTIPLE DOMAINS

This call would be used to change configuration of multiple domains. Example Call Changing Vanity DNS ID to 9999 for domain IDs 999999 and 999991:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed -X PUT accept:application/json -H content-type:application/json -d '{"ids":["999999","999991"],"vanityId":"9999"}'

Example Error:
{"error":["Invalid domain IDs specified.","Invalid Vanity NS configuration."]}

Either an invalid domain ID or Vanity DNS ID was specified.

Managed DNS DELETE MULTIPLE DOMAINS

This call would be used to delete multiple domains with IDs 999999 and 999991. Example Call:
./dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dn/ -H accept:application/json -H content-type:application/json -X DELETE -d '[999999,999991]'

Managed DNS POST MULTIPLE DOMAINS

This call would be used to create multiple domains. Example Call Creating multiple domains:
13

./dnsmeapi.pl -v https://api.dnsmadeeasy.com/V2.0/dns/managed -X POST accept:application/json -H content-type:application/json -d '{"names":["example01.com","example02.com"]}'

Example Error:
{"error":["Domain name conflicts with existing zones."]}

The domain name exists within a DNS Made Easy Account already.

14

SOA Record
The SOA Record data type contains parameters for custom SOA record configuration. /soa Field Name name id email ttl comp serial refresh retry expire negativeCache

Type String numeric String numeric String numeric numeric numeric numeric Numeric

Description SOA Record name Identifier (system defined) Contact email address TTL of SOA record (in seconds) Primary name server Starting zone serial number Zone refresh time (in seconds) Failed Refresh retry time (in seconds) Expire time of zone (in seconds) Record not found cache (in seconds)

SOA Record GET

This call will display all custom SOA records defined for an account. Example Call:
./dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dns/soa/ -H accept:application/json -H content-type:application/json -X GET

Creating a domain(s) with a Custom SOA

This call will create the domains example.com and example1.com and assigned the custom SOA with ID 9999. Example Call:
./dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dns/managed/ -H accept:application/json -H content-type:application/json -X POST -d '{"names":["example.com","example1.com"], "soaId":"9999" }' 15

Updating a domain(s) with an SOA

This call will assign the domains with IDs 999999 and 999991 with the custom SOA record with ID 9999. Example Call:
./dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dns/managed/ -H accept:application/json -H content-type:application/json -X PUT -d '{"ids":["999999","999991"], "soaId":"9999"}'

16

Vanity DNS
The Vanity DNS data type contains parameters for vanity DNS configuration. /vanity Field Name name

Type String

id numeric nameServerGroupId numeric public boolean servers default nameServerGroup String boolean String

Description The identifiable name of the Vanity DNS group Identifier (system defined) The name server group the config is assigned True represents a system defined rather than user defined vanity configuration. The vanity host names defined in the config True sets the configuration as the default Lists the DNS Made Easy name servers the configuration is defined for.

Vanity Name Servers GET

This call will display a full list of all vanity name server groups public and private defined within an account. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/vanity

Example Output:
{"data":[{"name":"Example Vanity","id":9999,"nameServerGroupId":1,"public":false,"servers":["ns0 .example.com","ns1.example.com"],"default":false,"nameServerGroup":"ns 0,ns1,ns2,ns3,ns4.dnsmadeeasy.com"} ],"totalRecords":1,"totalPages":1,"page":1}

17

Template
The Template data type contains parameters for Record Set Template configuration. /template Field Name name id domainIds publicTemplate

Type String numeric numeric boolean

Description Template name Identifier (system defined) Domain IDs currently assigned to the template True represents a system defined public template rather than user defined account specific template.

Template GET
This call would return all templates public and private within the account including. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/template/

Example Output:
{"name":"Example Template","id":9999,"domainIds":[],"publicTemplate":false}

Example Error: Generic API 404 Error for a badly formulated request.

Template Record GET

This call would return the records within a template based on the template ID including their associated record IDs. This call is for A records within the template with ID 9999. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/ dns/template/9999/records?type=A

Example Output:
18

{"data":[{"name":"www","value":"1.1.1.1","id":9999999,"type":"A","sour ce":2,"gtdLocation":"DEFAULT","ttl":1800,"sourceId":9999,"failover":fa lse,"monitor":false,"hardLink":false,"dynamicDns":false,"failed":false }],"page":1,"totalPages":1,"totalRecords":1}

Example Error: Generic API 404 Error for a badly formulated request.

Template Record POST

This call will create an A record within the template with the ID 9999. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/template/9999/records/ -X POST -H accept:application/json -H content-type:application/json -d '{"name":"www","type":"A","value"2.2.2.2","gtdLocation":"DEFAULT","ttl ":86400}'

Example Output:
{"name":"www","value":"2.2.2.2","id":9999999,"type":"A","ttl":86400,"s ourceId":9999,"failover":false,"monitor":false,"gtdLocation":"DEFAULT" ,"source":2,"dynamicDns":false,"failed":false,"hardLink":false}

Example Error: Generic API 404 Error for a badly formulated request.

Template Record DELETE

This call will delete the record with ID 9999999 from the template with ID 9999. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/template/9999/records?ids=9999999 -X DELETE

19

Account ACL
The Account ACL data type contains parameters for Access Control Lists defined for the account. /transferAcl Field Name name id ips

Type String numeric numeric

Description ACL Identifiable name Identifier (system defined) The IP addresses defined in the ACL

Transfer ACL GET

Example Call: This call will display a full list of all AXFR transfer ACLs.
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/transferAcl

Example Output:
{"data":[{"name":"TestACL","id":9999,"ips":["1.2.3.4"]}],"totalRecords ":1,"totalPages":1,"page":1}

20

Folder
The Folder data type contains parameters for managing domain folders defined in the account. /security/folder Field Name Type value numeric label String

Description Identifier (system defined) The Name of the Folder

Folder GET
Example Call: This call will display a full list of al folders defined in the account.
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/security/folder

Example Output:
[{"value":99999,"label":"Default"},{"value":99991,"label":"Folder1"}]

21

Query Usage
The query usage data type contains information for account query usage. /usageApi/queriesApi/ Field Name id total month year accountId primaryCount primaryTotal secondaryCount secondaryTotal

Type numeric numeric numeric numeric numeric numeric numeric numeric numeric

Description identifier Query total Month Year Account identifier Count of primary domains Query count for primary domains Count of secondary domains Query count for secondary domains

Example XML Representation: <queryUsage> <total>17372</total> <month>12</month> <year>2011<month> <accountId>60630</accountId> </queryUsage> Example JSON Representation:
[{"id":null,"total":1712,"month":9,"year":2011,"day":null,"accountId":99999," primaryCount":0,"primaryTotal":0,"secondaryCount":0,"secondaryTotal":0}, {"id":null,"total":2386,"month":10,"year":2011,"day":null,"accountId":99999," primaryCount":0,"primaryTotal":0,"secondaryCount":0,"secondaryTotal":0}, {"id":null,"total":3444,"month":11,"year":2011,"day":null,"accountId":99999," primaryCount":0,"primaryTotal":0,"secondaryCount":0,"secondaryTotal":0}, {"id":null,"total":17372,"month":12,"year":2011,"day":null,"accountId":99999, "primaryCount":0,"primaryTotal":0,"secondaryCount":0,"secondaryTotal":0}, {"id":null,"total":16481,"month":1,"year":2012,"day":null,"accountId":99999," primaryCount":0,"primaryTotal":0,"secondaryCount":0,"secondaryTotal":0}]

22

All Query Usage

This call will display a full report of query traffic within the account for all months and all domains.
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/usageApi/queriesApi

Query Usage for a Single Month

This call will display query usage for April of 2012 for all domains. Example Call:
./dnsmeapi.pl https:// api.dnsmadeeasy.com/V2.0/dns/usageApi/queriesApi/2012/4

Query Usage for a Single Month for a Single Domain

This call will display query usage for April of 2012 for the domain with ID 999999. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/usageApi/queriesApi/2012/4/managed/ 999999

23

Failover
The Template data type contains parameters for Record Set Template configuration. /monitor Field Name Type monitor boolean systemDescription String maxEmails sensitivity numeric numeric

Description True indicates System Monitoring Enabled The system description configured for the failover event notification. The number of emails sent to the contact for an outage. The number of checks placed against the primary IP before a Failover event occurs. List of Sensitivity IDs: Low (slower failover) = 8 Medium = 5 High = 3 The protocol for DNS Failover to monitor on. List of Protocol IDs: TCP = 1 UDP = 2 HTTP = 3 DNS = 4 SMTP = 5 HTTPS = 6 The port for DNS Failover to monitor on the specified protocol. True indicates DNS Failover Enabled True indicates the failback to the primary IP address is a manual process. False indicates the failback to the primary IP is an automatic process. The primary IP address The secondary IP address The tertiary IP address The quaternary IP address
24

protocolId

numeric

port failover autoFailover

numeric boolean boolean

ip1 ip2 ip3 ip4

numeric numeric numeric numeric

ip5

numeric

The quinary IP address

DNS Failover PUT

This call will configure DNS Failover for a record with ID 9999999. Example Call:
./dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/monitor/9999999 -X PUT accept:application/json -H content-type:application/json -d '{"monitor":"true","systemDescription":"Web Server","maxEmails":"2","sensitivity":"5","protocolId":"3","port":"80","failover":"true","autoFailover":"t rue","ip1":"1.1.1.3","ip2":"1.1.1.4"}'

25

Record
The record data type contains information about a record for a given domain. The following fields are available:

/records Field Name id name type value

Type number string string string

ttl gtdlocation password description keywords title redirecttype

number string string string string string string

hardlink

Boolean

Description Unique record identifier Record name. Record type. Values: A, AAAA, CNAME, HTTPRED, MX, NS, PTR, SRV, TXT HTTPRED: <redirection URL> MX: <priority> <target name> NS: <name server> PTR: <target name> SRV: <priority> <weight> <port> <target name> TXT: <text value> Time to live. The amount of time a record will be cached before being refreshed. Global Traffic Director location. Values: DEFAULT, US_EAST, US_WEST, EUROPE For A records. Password used to authenticate for dynamic DNS. For HTTPRED records. A description of the HTTPRED record. For HTTPRED records. Keywords associated with the HTTPRED record. For HTTPRED records. The title of the HTTPRED record. For HTTPRED records. Type of redirection performed. Values: Hidden Frame Masked, Standard 302, Standard 301 For HTTPRED records

26

Example XML Representation: <record> <data>208.94.147.96</data> <gtdLocation>Default</gtdLocation> <id>123456</id> <name>dummy</name> <ttl>1800</ttl> <type>A</type> </record> <record> <data>mail.myDomain.com.</data> <gtdLocation>Default</gtdLocation> <id>123456</id> <name>dummy2</name> <ttl>1800</ttl> <type>MX</type> </record> Example JSON Representations: { "name":"dummy", "id":123456, "type":"A", "data":"208.94.147.96", "gtdLocation":"Default", "ttl":1800 } { "name":"dummy2", "id":123456, "type":"MX", "data":"10 mail.myDomain.com.", "gtdLocation":"Default", "ttl":1800 }

Managed DNS Records GET

This call would display all the records in a single domain ID and returns the record IDs of each associated record.
27

Example Call View records in domain ID 999999:

./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/999999/records

Example Output:
{"data":[{"name":"mail","value":"www","id":9999999,"type":"CNAME","ttl ":1800,"sourceId":999999,"failover":false,"monitor":false,"gtdLocation ":"DEFAULT","source":1,"dynamicDns":false,"failed":false,"hardLink":fa lse},{"name":"google","value":"http://www.google.com/","id":9999991,"t ype":"HTTPRED","ttl":1800,"sourceId":999999,"failover":false,"monitor" :false,"title":"title","gtdLocation":"DEFAULT","redirectType":"Standar d 302","keywords":"keywords","description":"description","source":1,"dyn amicDns":false,"failed":false,"hardLink":false},{"name":"www","value": "5.5.5.5","id":9999992,"type":"A","ttl":1800,"sourceId":999999,"failov er":false,"monitor":false,"gtdLocation":"EUROPE","source":1,"dynamicDn s":false,"failed":false,"hardLink":false}],"page":1,"totalPages":1,"to talRecords":3}

Example Error: Generic API 404 Error for a badly formulated request.

Managed DNS Record PUT

This call will update a record with ID 2222222 in the domain with ID 999999. The call would change the A record mail to the IP 1.1.1.1 with a TTL of 86400 seconds. Example Call:
./dnsmeapi.pl http://api.dnsmadeeasy.com/V2.0/dns/managed/999999/records/2222222/ -X PUT -H accept:application/json -H content-type:application/json -d '{"name":"mail","type":"A","value":"1.1.1.1","id":"2222222","gtdLocati on":"DEFAULT","ttl":86400}'

Managed DNS Records POST

This call is used to create a record in a domain and will return the associated record ID of the record that is created. Example Call Create a record in domain ID 999999:

28

./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/999999/records/ -X POST H accept:application/json -H content-type:application/json -d '{"name":"test","type":"A","value":"1.1.1.1","gtdLocation":"DEFAULT"," ttl":86400}'

Example Output:
{"name":"test","value":"1.1.1.1","id":9999993,"type":"A","ttl":86400," sourceId":999999,"failover":false,"monitor":false,"gtdLocation":"DEFAU LT","source":1,"dynamicDns":false,"failed":false,"hardLink":false}

Example Error:
{"error":["Record with this type (A), name (test), and value (1.1.1.1) already exists."]}

The A record with the name and IP entered already exists.

Managed DNS Records DELETE

This call is used to delete a record from a domain. Example Call:
./dnsmeapi.pl https://api.dnsmadeeasy.com/V2.0/dns/managed/999999/records?ids=999999 9 -X DELETE

29

Resources & Methods

The following resources and methods are available with the DNS Made Easy API: /dns/managed operate on multiple domains for your account Method HTTP Status Codes Description GET 200 OK Returns a list of all domain names for your account. DELETE 200 OK Deletes all domains for your account PUT 200 OK Updates multiple domains based on the identifiers in the ids field. The following values can be updated for all domains provided in the list: Global Traffic Director (Boolean) Applied Template (numeric ID) Vanity NS Config (numeric ID) Custom SOA Record (numeric ID) Zone Transfer (numeric ID) Folder (numeric ID) POST 200 OK Creates multiple domains based on a list of names provided within a MultiDomain object. /dns/managed/{domainId} operate on a single domain Method HTTP Status Codes Description GET 200 OK Returns the domain object representation of the specified domain. DELETE 200 OK Deletes the specified domain 404 specified domain WARNING: This is irreversible! name is not found PUT 200 OK Updates a domains based on the domainId identifier in the path. Pass in a Domain object in XML or JSON with the new values.

30

/dns/managed/{domainId}/records operate on multiple records for one domain Method HTTP Status Codes Description GET 200 OK Returns the record object representation of the records for the specified domain. The following are URL parameters that may be added to determine the data returned: type Record type. Values: A, AAAA, CNAME, HTTPRED, MX, NS, PTR, SRV, TXT rows Number of rows returns page The page number of records, based on the number of rows returned DELETE 200 OK Deletes the specified records using a list of record identifiers provided in XML or JSON format for the given template. WARNING: This is irreversible! POST 200 OK Creates a series of records for the given domain using the list of record information provided in XML or JSON format

/dns/managed/{templateId}/records operate on multiple records for one template Method HTTP Status Codes Description GET 200 OK Returns record object representations of the records for the specified template. The following are URL parameters that may be added to determine the data returned: type Record type. Values: A, AAAA, CNAME, HTTPRED, MX, NS, PTR, SRV, TXT rows Number of rows returned page The page number of records, based on the number of rows returned DELETE 200 OK Deletes the specified records using a list of 404 specified domain record identifiers provided in XML or JSON name is not found format for the given template.
31

PUT

200 - OK

POST

200 OK

WARNING: This is irreversible and affects the records for any domain associated with the given template! Replaces the current set of records for a template using the provided list of records provided in XML or JSON format for the given template. WARNING: This is irreversible and affects the records for any domain associated with the given template! Creates a record for the given template using the record information provided in XML or JSON format

/dns/secondary operate on multiple secondary domains for your account Method HTTP Status Codes Description GET 200 OK Returns a list of all domain names for your account. DELETE 200 OK Deletes all domains for your account PUT 200 OK Updates multiple domains based on the identifiers in the ids field. The following values can be updated for all domains provided in the list: Global Traffic Director Applied Template Vanity NS Config Custom SOA Record Zone Transfer Folder POST 200 OK Creates multiple domains based on a list of names provided within a MultiDomain object.
32

/dns/secondary/{domainId} operate on a single secondary domain Method HTTP Status Codes Description GET 200 OK Returns the domain object representation of the specified domain. DELETE 200 OK Deletes the specified domain 404 specified domain WARNING: This is irreversible! name is not found PUT 200 OK Updates a domains based on the domainId identifier in the path. Pass in a Domain object in XML or JSON with the new values.

/dns/secondary/{domainId}/records operate on multiple records for one secondary domain Method HTTP Status Codes Description GET 200 OK Returns the record object representation of the records for the specified domain. The following are URL parameters that may be added to determine the data returned: type Record type. Values: A, AAAA, CNAME, HTTPRED, MX, NS, PTR, SRV, TXT rows Number of rows returns page The page number of records, based on the number of rows returned DELETE 200 OK Deletes the specified records using a list of record identifiers provided in XML or JSON format for the given template. WARNING: This is irreversible! POST 200 OK Creates a series of records for the given domain using the list of record information provided in XML or JSON format

33

/dns/managed/{templateId}/records operate on multiple records for one template Method HTTP Status Codes Description GET 200 OK Returns record object representations of the records for the specified template. The following are URL parameters that may be added to determine the data returned: type Record type. Values: A, AAAA, CNAME, HTTPRED, MX, NS, PTR, SRV, TXT rows Number of rows returned page The page number of records, based on the number of rows returned DELETE 200 OK Deletes the specified records using a list of 404 specified domain record identifiers provided in XML or JSON name is not found format for the given template. WARNING: This is irreversible and affects the records for any domain associated with the given template! PUT 200 - OK Replaces the current set of records for a template using the provided list of records provided in XML or JSON format for the given template. WARNING: This is irreversible and affects the records for any domain associated with the given template! POST 200 OK Creates a record for the given template using the record information provided in XML or JSON format

34

/dns/managed/{templateId}/records/{recordId} operate on one record for one template Method HTTP Status Codes Description DELETE 200 OK Deletes the specified record for the given 404 specified domain template. name is not found WARNING: This is irreversible and affects the records for any domain associated with the given template! PUT 200 OK Updates a record for the given template using the record information provided in XML or JSON format

/usageApi/queriesApi get account usage information by year and month Method HTTP Status Codes Description GET 200 OK Returns a list of QueryUsage objects. /usageApi/queriesApi/{year}/{month} get account usage information for a given year and month Method HTTP Status Codes Description GET 200 OK Returns a list of QueryUsage objects. /usageApi/queriesApi/{year}/{month}/managed/{domainId} get usage information for a given year and month for one domain Method HTTP Status Codes Description GET 200 OK Returns a list of QueryUsage objects.

/usageApi/queriesApi/{year}/{month}/secondary/{domainId} get usage information for a given year and month for one secondary domain Method HTTP Status Codes Description GET 200 OK Returns a list of QueryUsage objects.

35

Error Reporting
Generic Bad API Request Error
This is a generic error response code which indicates an error in the request issued, typically formatting or syntax related.
<html><head><title>Apache Tomcat/7.0.12 - Error report</title><style><!--H1 {font-family:Tahoma,Arial,sansserif;color:white;background-color:#525D76;font-size:22px;} H2 {fontfamily:Tahoma,Arial,sans-serif;color:white;backgroundcolor:#525D76;font-size:16px;} H3 {font-family:Tahoma,Arial,sansserif;color:white;background-color:#525D76;font-size:14px;} BODY {font-family:Tahoma,Arial,sans-serif;color:black;backgroundcolor:white;} B {font-family:Tahoma,Arial,sansserif;color:white;background-color:#525D76;} P {fontfamily:Tahoma,Arial,sans-serif;background:white;color:black;fontsize:12px;}A {color : black;}A.name {color : black;}HR {color : #525D76;}--></style> </head><body><h1>HTTP Status 404 - Not Found</h1><HR size="1" noshade="noshade"><p><b>type</b> Status report</p><p><b>message</b> <u>Not Found</u></p><p><b>description</b> <u>The requested resource (Not Found) is not available.</u></p><HR size="1" noshade="noshade"><h3>Apache Tomcat/7.0.12</h3></body></html>

36