See the API's various operations for details on their request parameters and response data.
Operation | Method | Endpoint |
---|---|---|
Zones | ||
List zones | GET | /zones |
Create a zone | POST | /zones |
Get zones DNSSEC status | GET | /zones/dns-sec-status |
Get secondary zones transfer status | POST | /zones/zone-transfer-status |
Get zone's settings | GET | /zones/{zone} |
Update zone's settings | PUT | /zones/{zone} |
Get zone's aliases | GET | /zones/{zone}/aliases |
Get zone's contract | GET | /zones/{zone}/contract |
Record Sets | ||
Get record set names for zone | GET | /zones/{zone}/names |
Get 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 zone's record sets | GET | /zones/{zone}/recordsets |
Create multiple record sets | POST | /zones/{zone}/recordsets |
Replace a record set | PUT | /zones/{zone}/recordsets |
Get master zone file | GET | /zones/{zone}/zone-file |
Post master zone file | POST | /zones/{zone}/zone-file |
TSIG Keys | ||
List TSIG keys | GET | /keys |
Update TSIG key for multiple zones | POST | /keys/bulk-update |
List zones using TSIG key | POST | /keys/used-by |
Delete zone's TSIG key | DELETE | /zones/{zone}/key |
Get zone's TSIG key | GET | /zones/{zone}/key |
Update zone's TSIG key | PUT | /zones/{zone}/key |
List users of zone's TSIG key | GET | /zones/{zone}/key/used-by |
Bulk Zone Operations | ||
Submit bulk-create request | POST | /zones/create-requests |
Check bulk-create status | GET | /zones/create-requests/{requestId} |
Get bulk-create result | GET | /zones/create-requests/{requestId}/result |
Submit bulk-delete request | POST | /zones/delete-requests |
Check bulk-delete status | GET | /zones/delete-requests/{requestId} |
Get bulk-delete result | GET | /zones/delete-requests/{requestId}/result |
Change Lists | ||
List user's change lists | GET | /changelists |
Create a change list | POST | /changelists |
Search for change lists | POST | /changelists/search |
Delete change list | DELETE | /changelists/{zone} |
Get change list | GET | /changelists/{zone} |
Show changes | GET | /changelists/{zone}/diff |
Get record set names for change list | GET | /changelists/{zone}/names |
Get record set types for name and change list | GET | /changelists/{zone}/names/{name}/types |
Get a record set for change list | GET | /changelists/{zone}/names/{name}/types/{type} |
Get record sets for change list | GET | /changelists/{zone}/recordsets |
Upload master zone File to change list | POST | /changelists/{zone}/recordsets |
Modify record set for 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 change list | POST | /changelists/{zone}/submit |
Zone Versions | ||
List zone's versions | GET | /zones/{zone}/versions |
Show differences | GET | /zones/{zone}/versions/diff |
Get zone version | GET | /zones/{zone}/versions/{uuid} |
Get version's record sets | GET | /zones/{zone}/versions/{uuid}/recordsets |
Reactivate version | POST | /zones/{zone}/versions/{uuid}/recordsets/activate |
Get version's master zone file | GET | /zones/{zone}/versions/{uuid}/zone-file |
Data Services | ||
List authoritative nameservers | 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 |