A DNS zone is a distinct part of the domain namespace and allows granular control of DNS components.
List DNS zones
Retrieve the list of DNS zones you can manage and filter DNS zones associated with specific domain names.
query Parameters
domainDomain on which to filter the returned DNS zones.
dns_zoneDNS zone on which to filter the returned DNS zones.
organization_idOrganization ID on which to filter the returned DNS zones.
project_idProject ID on which to filter the returned DNS zones.
order_bySort order of the returned DNS zones.
pagePage number to return, from the paginated results.
page_sizeMaximum number of DNS zones to return per page.
dns_zonesDNS zones on which to filter the returned DNS zones.
created_afterOnly list DNS zones created after this date. (RFC 3339 format)
created_beforeOnly list DNS zones created before this date. (RFC 3339 format)
updated_afterOnly list DNS zones updated after this date. (RFC 3339 format)
updated_beforeOnly list DNS zones updated before this date. (RFC 3339 format)
List DNS zones › Responses
total_countTotal number of DNS zones matching the requested criteria.
Paginated returned DNS zones.
Create a DNS zone
Create a new DNS zone specified by the domain name, the subdomain and the Project ID.
Create a DNS zone › Request Body
domainDomain in which to create the DNS zone.
subdomainSubdomain of the DNS zone to create.
project_idProject ID in which to create the DNS zone.
Create a DNS zone › Responses
domainsubdomainnsns_defaultns_masterstatusmessageupdated_at(RFC 3339 format)
project_idlinked_productsDelete a DNS zone
Update a DNS zone
Update the name and/or the Organizations for a DNS zone.
path Parameters
dns_zoneThe full name of the DNS zone to modify. For a root zone (e.g., example.com), enter example.com. For a specific sub-zone (e.g., prod.example.com), enter prod.example.com.
Update a DNS zone › Request Body
new_dns_zoneName of the new DNS zone to create.
project_idProject ID in which to create the new DNS zone.
Update a DNS zone › Responses
domainsubdomainnsns_defaultns_masterstatusmessageupdated_at(RFC 3339 format)
project_idlinked_productsClone a DNS zone
Clone an existing DNS zone with all its records into a new DNS zone.
path Parameters
dns_zoneDNS zone to clone.
Clone a DNS zone › Request Body
dest_dns_zoneDestination DNS zone in which to clone the chosen DNS zone.
overwriteSpecifies whether or not the destination DNS zone will be overwritten.
project_idProject ID of the destination DNS zone.
Clone a DNS zone › Responses
domainsubdomainnsns_defaultns_masterstatusmessageupdated_at(RFC 3339 format)
project_idlinked_productsRefresh a DNS zone
Refresh an SOA DNS zone to reload the records in the DNS zone and update the SOA serial. You can recreate the given DNS zone and its sub DNS zone if needed.
path Parameters
dns_zoneDNS zone to refresh.
Refresh a DNS zone › Request Body
recreate_dns_zoneSpecifies whether or not to recreate the DNS zone.
recreate_sub_dns_zoneSpecifies whether or not to recreate the sub DNS zone.
Refresh a DNS zone › Responses
DNS zones returned.
Get the DNS zone's TSIG key
List a user's TLS certificates
List all the TLS certificates a user has created, specified by the user's Project ID and the DNS zone.
query Parameters
dns_zonepagepage_sizeproject_idList a user's TLS certificates › Responses
total_countCreate or get the DNS zone's TLS certificate
Create a new TLS certificate or retrieve information about an existing TLS certificate.
Create or get the DNS zone's TLS certificate › Request Body
dns_zonealternative_dns_zonesCreate or get the DNS zone's TLS certificate › Responses
dns_zonealternative_dns_zonesstatusprivate_keycertificate_chaincreated_at(RFC 3339 format)
expired_at(RFC 3339 format)
Get a DNS zone's TLS certificate
Get the DNS zone's TLS certificate. If you do not have a certificate, the output returns no certificate found.
path Parameters
dns_zoneGet a DNS zone's TLS certificate › Responses
dns_zonealternative_dns_zonesstatusprivate_keycertificate_chaincreated_at(RFC 3339 format)
expired_at(RFC 3339 format)