See the API's various operations for details on their request parameters and response data.
You can also run this API with a Postman collection.
| Operation | Method | Endpoint |
|---|---|---|
| Zones | ||
| List zones | GET | /zones |
| Create a zone | POST | /zones |
| Get a zone's DNSSEC status | POST | /zones/dns-sec-status |
| Get secondary zones transfer status | POST | /zones/zone-transfer-status |
| Get a zone's settings | GET | /zones/{zone} |
| Update a zone's settings | PUT | /zones/{zone} |
| Get a zone's aliases | GET | /zones/{zone}/aliases |
| Get a zone's contract | GET | /zones/{zone}/contract |
| Get a zone's DNSSEC DNSKEY records | GET | /zones/{zone}/dnskeys |
| Zone versions | ||
| List a zone's versions | GET | /zones/{zone}/versions |
| Show zone version differences | GET | /zones/{zone}/versions/diff |
| Get a zone version | GET | /zones/{zone}/versions/{uuid} |
| Get a version's record sets | GET | /zones/{zone}/versions/{uuid}/recordsets |
| Reactivate a version | POST | /zones/{zone}/versions/{uuid}/recordsets/activate |
| Get a version's master zone file | GET | /zones/{zone}/versions/{uuid}/zone-file |
| Record sets | ||
| List record set names for a zone | GET | /zones/{zone}/names |
| List record set types for name and zone | GET | /zones/{zone}/names/{name}/types |
| Delete a record set | DELETE | /zones/{zone}/names/{name}/types/{type} |
| Get a record set | GET | /zones/{zone}/names/{name}/types/{type} |
| Create a record set | POST | /zones/{zone}/names/{name}/types/{type} |
| Replace a record set | PUT | /zones/{zone}/names/{name}/types/{type} |
| Get a zone's record sets | GET | /zones/{zone}/recordsets |
| Create record sets | POST | /zones/{zone}/recordsets |
| Replace record sets | PUT | /zones/{zone}/recordsets |
| Get a master zone file | GET | /zones/{zone}/zone-file |
| Upload a master zone file | POST | /zones/{zone}/zone-file |
| Change lists | ||
| List user's change lists | GET | /changelists |
| Create a change list | POST | /changelists |
| Search for change lists | POST | /changelists/search |
| Delete a change list | DELETE | /changelists/{zone} |
| Get a change list | GET | /changelists/{zone} |
| Show changes | GET | /changelists/{zone}/diff |
| List record set names for a change list | GET | /changelists/{zone}/names |
| List record set types for name and change list | GET | /changelists/{zone}/names/{name}/types |
| Get a record set for a change list | GET | /changelists/{zone}/names/{name}/types/{type} |
| List record sets for a change list | GET | /changelists/{zone}/recordsets |
| Upload a master zone file to a change list | POST | /changelists/{zone}/recordsets |
| Modify record set for a change list | POST | /changelists/{zone}/recordsets/add-change |
| Get change list settings | GET | /changelists/{zone}/settings |
| Update change list settings | PUT | /changelists/{zone}/settings |
| Submit a change list | POST | /changelists/{zone}/submit |
| Data services | ||
| List authoritative name servers | GET | /data/authorities |
| List contracts | GET | /data/contracts |
| List DNSSEC algorithms | GET | /data/dns-sec-algorithms |
| List edge hostnames | GET | /data/edgehostnames |
| List groups | GET | /data/groups |
| List record types | GET | /data/recordset-types |
| List TSIG key algorithms | GET | /data/tsig-algorithms |
| Shield NS53 | ||
| List proxies | GET | /proxies |
| Create a proxy | POST | /proxies |
| List valid proxy health check record set types | GET | /proxies/healthcheck-recordset-types |
| Get a proxy | GET | /proxies/{proxyId} |
| Update a proxy | PUT | /proxies/{proxyId} |
| List proxy zones | GET | /proxies/{proxyId}/zones |
| Get a bulk proxy zone create results for a proxy | GET | /proxies/{proxyId}/zones/create-requests |
| Submit a bulk proxy zone create request | POST | /proxies/{proxyId}/zones/create-requests |
| Check bulk proxy zone create status | GET | /proxies/{proxyId}/zones/create-requests/{requestId} |
| Get a bulk proxy zone create result | GET | /proxies/{proxyId}/zones/create-requests/{requestId}/result |
| Submit a bulk proxy zone delete request | POST | /proxies/{proxyId}/zones/delete-requests |
| Get all bulk proxy zone delete results | GET | /proxies/{proxyId}/zones/delete-requests/results |
| Check bulk proxy zone delete status | GET | /proxies/{proxyId}/zones/delete-requests/{requestId} |
| Get a bulk proxy zone delete result | GET | /proxies/{proxyId}/zones/delete-requests/{requestId}/result |
| Convert a proxy zone filter mode to all | POST | /proxies/{proxyId}/zones/filter-mode-convert/to-all |
| Convert a proxy zone filter mode to automatic | POST | /proxies/{proxyId}/zones/filter-mode-convert/to-automatic |
| Convert a proxy zone filter mode to manual | POST | /proxies/{proxyId}/zones/filter-mode-convert/to-manual |
| Convert a proxy zone filter mode to none | POST | /proxies/{proxyId}/zones/filter-mode-convert/to-none |
| List proxy zone keys | GET | /proxies/{proxyId}/zones/keys |
| Get a proxy zone by name | GET | /proxies/{proxyId}/zones/{name} |
| Delete apex alias for a proxy zone | DELETE | /proxies/{proxyId}/zones/{name}/apex-alias |
| Save the apex alias for a proxy zone | PUT | /proxies/{proxyId}/zones/{name}/apex-alias |
| Delete a proxy zone TSIG key by name | DELETE | /proxies/{proxyId}/zones/{name}/key |
| Get a proxy zone TSIG key by name | GET | /proxies/{proxyId}/zones/{name}/key |
| Update a proxy zone TSIG key by name | PUT | /proxies/{proxyId}/zones/{name}/key |
| List proxies for a TSIG key | GET | /proxies/{proxyId}/zones/{name}/key/used-by |
| Get a manual filter report | GET | /proxies/{proxyId}/zones/{name}/manual-filter-names |
| Manage manual filter names | POST | /proxies/{proxyId}/zones/{name}/manual-filter-names/manage |
| Initialize manual filter names with a zone file | POST | /proxies/{proxyId}/zones/{name}/manual-filter-names/zone-file |
| TSIG keys | ||
| List TSIG keys | GET | /keys |
| Update a TSIG key across zones | POST | /keys/bulk-update |
| List zones using TSIG key | POST | /keys/used-by |
| Zones to contract using TSIG key | POST | /keys/used-by/zone-contract-map |
| Delete a zone's TSIG key | DELETE | /zones/{zone}/key |
| Get a zone's TSIG key | GET | /zones/{zone}/key |
| Update a zone's TSIG key | PUT | /zones/{zone}/key |
| List users of a zone's TSIG key | GET | /zones/{zone}/key/used-by |
| Bulk zones | ||
| Search bulk zone convert requests | GET | /zones/convert-requests |
| Submit a bulk zone convert alias request | POST | /zones/convert-requests/alias |
| Submit a bulk zone convert primary request | POST | /zones/convert-requests/primary |
| Submit a bulk zone convert secondary request | POST | /zones/convert-requests/secondary |
| List SOA serials for secondary zones | POST | /zones/convert-requests/serials |
| Check bulk zone convert status | GET | /zones/convert-requests/{requestId} |
| Get bulk zone convert results | GET | /zones/convert-requests/{requestId}/result |
| Submit a bulk zone create request | POST | /zones/create-requests |
| Check bulk zone create status | GET | /zones/create-requests/{requestId} |
| Get bulk zone create results | GET | /zones/create-requests/{requestId}/result |
| Submit a bulk zone delete request | POST | /zones/delete-requests |
| Check bulk zone delete status | GET | /zones/delete-requests/{requestId} |
| Get bulk zone delete results | GET | /zones/delete-requests/{requestId}/result |