API summary

See the API's various operations for details on their request parameters and response data.

OperationMethodEndpoint
Bulk Zone Operations
Submit a bulk-create requestPOST/zones/‚Äčcreate-requests
Check bulk-create statusGET/zones/‚Äčcreate-requests/‚Äč{requestId}
Get bulk-create resultsGET/zones/‚Äčcreate-requests/‚Äč{requestId}/‚Äčresult
Submit a bulk-delete requestPOST/zones/‚Äčdelete-requests
Check bulk-delete statusGET/zones/‚Äčdelete-requests/‚Äč{requestId}
Get bulk-delete resultsGET/zones/‚Äčdelete-requests/‚Äč{requestId}/‚Äčresult
Change lists
List user's change listsGET/changelists
Create a change listPOST/changelists
Search for change listsPOST/changelists/‚Äčsearch
Delete a change listDELETE/changelists/‚Äč{zone}
Get a change listGET/changelists/‚Äč{zone}
Show changesGET/changelists/‚Äč{zone}/‚Äčdiff
List record set names for a change listGET/changelists/‚Äč{zone}/‚Äčnames
List record set types for name and change listGET/changelists/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes
Get a record set for a change listGET/changelists/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes/‚Äč{type}
List record sets for a change listGET/changelists/‚Äč{zone}/‚Äčrecordsets
Upload a master zone file to a change listPOST/changelists/‚Äč{zone}/‚Äčrecordsets
Modify record set for a change listPOST/changelists/‚Äč{zone}/‚Äčrecordsets/‚Äčadd-change
Get change list settingsGET/changelists/‚Äč{zone}/‚Äčsettings
Update change list settingsPUT/changelists/‚Äč{zone}/‚Äčsettings
Submit a change listPOST/changelists/‚Äč{zone}/‚Äčsubmit
Data Services
List authoritative name serversGET/data/‚Äčauthorities
List contractsGET/data/‚Äčcontracts
List DNSSEC algorithmsGET/data/‚Äčdns-sec-algorithms
List edge hostnamesGET/data/‚Äčedgehostnames
List groupsGET/data/‚Äčgroups
List record typesGET/data/‚Äčrecordset-types
List TSIG key algorithmsGET/data/‚Äčtsig-algorithms
Record sets
List record set names for a zoneGET/zones/‚Äč{zone}/‚Äčnames
List record set types for name and zoneGET/zones/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes
Delete a record setDELETE/zones/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes/‚Äč{type}
Get a record setGET/zones/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes/‚Äč{type}
Create a record setPOST/zones/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes/‚Äč{type}
Replace a record setPUT/zones/‚Äč{zone}/‚Äčnames/‚Äč{name}/‚Äčtypes/‚Äč{type}
Get a zone's record setsGET/zones/‚Äč{zone}/‚Äčrecordsets
Create record setsPOST/zones/‚Äč{zone}/‚Äčrecordsets
Replace record setsPUT/zones/‚Äč{zone}/‚Äčrecordsets
Get a master zone fileGET/zones/‚Äč{zone}/‚Äčzone-file
Upload a master zone filePOST/zones/‚Äč{zone}/‚Äčzone-file
TSIG Keys
List TSIG keysGET/keys
Update a TSIG key across zonesPOST/keys/‚Äčbulk-update
List zones using TSIG keyPOST/keys/‚Äčused-by
Delete a zone's TSIG keyDELETE/zones/‚Äč{zone}/‚Äčkey
Get a zone's TSIG keyGET/zones/‚Äč{zone}/‚Äčkey
Update a zone's TSIG keyPUT/zones/‚Äč{zone}/‚Äčkey
List users of a zone's TSIG keyGET/zones/‚Äč{zone}/‚Äčkey/‚Äčused-by
Zone Versions
List a zone's versionsGET/zones/‚Äč{zone}/‚Äčversions
Show differencesGET/zones/‚Äč{zone}/‚Äčversions/‚Äčdiff
Get a zone versionGET/zones/‚Äč{zone}/‚Äčversions/‚Äč{uuid}
Get a version's record setsGET/zones/‚Äč{zone}/‚Äčversions/‚Äč{uuid}/‚Äčrecordsets
Reactivate a versionPOST/zones/‚Äč{zone}/‚Äčversions/‚Äč{uuid}/‚Äčrecordsets/‚Äčactivate
Get a version's master zone fileGET/zones/‚Äč{zone}/‚Äčversions/‚Äč{uuid}/‚Äčzone-file
Zones
List zonesGET/zones
Create a zonePOST/zones
Get a zone's DNSSEC statusPOST/zones/‚Äčdns-sec-status
Get secondary zones transfer statusPOST/zones/‚Äčzone-transfer-status
Get a zone's settingsGET/zones/‚Äč{zone}
Update a zone's settingsPUT/zones/‚Äč{zone}
Get a zone's aliasesGET/zones/‚Äč{zone}/‚Äčaliases
Get a zone's contractGET/zones/‚Äč{zone}/‚Äčcontract