Activate DNS service for an order
Turns on DNS for a domain order, which is required before DNS records can be added to it.
path Parameters
orderIdOrder Id of the Order for which the DNS service is to be activated
Activate DNS service for an order › Responses
OK
statusOperation status
messageStatus message (msg in the response)
zoneIdDNS zone identifier
transactionIdTransaction identifier when returned in the response
Pending invoice details when activation requires payment
Create a DNS record
Adds a new DNS record to a domain's zone — DNS must already be active on the order, and the record type is set in the request body.
path Parameters
domainNameCreate a DNS record › Request Body
recordTypeDNS record type (A, AAAA, CNAME, MX, NS, TXT, SRV, PTR).
valueRecord value (IPv4, IPv6, hostname, or text depending on record type).
hostHost label for the record.
ttlTime to live in seconds.
priorityPriority for MX or SRV records.
weightWeight for SRV records.
portPort for SRV records.
Create a DNS record › Responses
OK
statusOperation status.
messageHuman-readable result message.
transactionIdTransaction identifier when returned by the service.
Delete a DNS record
Removes a specific DNS record from a domain's zone — the record type is set in the request body.
path Parameters
domainNameDelete a DNS record › Request Body
recordTypeDNS record type to delete.
valueRecord value to delete.
hostHost label for the record.
Delete a DNS record › Responses
OK
statusOperation status.
messageHuman-readable result message.
transactionIdTransaction identifier when returned by the service.
Search DNS records
Returns DNS records in a domain's zone that match the filters you supply, such as record type or host name.
path Parameters
domainNameThe Domain name whose DNS record(s) you want to search
query Parameters
recordTypeType of record. Values may be: A MX CNAME TXT NS SRV AAAA
pageSizeNumber of Resource Records to be fetched
pagePage number for which details are to be fetched
hostHostname of the record
valueValue of the record
Search DNS records › Responses
OK
totalItemsTotal matching records
itemsOnPageRecords on this page
DNS record entries
statusOperation status
messageStatus message
Update a DNS record
Updates an existing DNS record in a domain's zone — the record type, such as A or CNAME, is set in the request body.
path Parameters
domainNameUpdate a DNS record › Request Body
recordTypeDNS record type to update.
currentValueCurrent record value to match.
valueNew record value.
hostHost label for the record.
ttlTime to live in seconds.
priorityPriority for MX or SRV records.
weightWeight for SRV records.
portPort for SRV records.
Update a DNS record › Responses
OK
statusOperation status.
messageHuman-readable result message.
transactionIdTransaction identifier when returned by the service.