List zones
GET https://{{host}}/config-dns/v2/zones
Get a list of all zones that the current user has access to manage. The response is paginated.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
contractIds | string | (Optional) Limits the list to those zones belonging to the specified contracts. | |
search | string | (Optional) Limits the list to those zones whose name matches the specified search string. | |
sortBy | string | (Optional) Sorts the list on the specified fields. You can specify multiple fields as a comma-separated list. Placing a dash before a field name sorts it in descending order. Sorting is ignored if used with showAll parameter. Valid sort keys include zone, contractId, comment, endCustomerId, lastModifiedDate, and lastActivatedDate. | |
subzoneGrant | string | (Optional) If included, limits the list of Edge DNS zones where subzoneGrants matches the specified boolean. | |
types | string | (Optional) If included, limits the list to one or more Edge DNS zone types, PRIMARY, SECONDARY, or ALIAS. Multiple types may be specified as a comma-separated list. | |
page | string | (Optional) Which page of results to return. The first page is page 1, the default value. | |
pageSize | string | (Optional) The number of results per page to return, 25 by default. | |
showAll | string | (Optional) Disables paging and sorting and shows the entire list all at once, false by default. Using this parameter may significantly increase the response time. | |
accountSwitchKey | string | (Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"metadata":{"contractIds":["C-0N7RAC7"],"page":1,"pageSize":3,"showAll":false,"totalElements":17},"zones":[{"activationState":"ACTIVE","aliasCount":1,"contractId":"K-0N7RAK71","lastActivationDate":"2021-01-03T12:00:00Z","lastModifiedBy":"jdupont","lastModifiedDate":"2021-01-03T12:00:00Z","signAndServe":false,"type":"PRIMARY","versionId":"ae02357c-693d-4ac4-b33d-8352d9b7c786","zone":"example.com"},{"activationState":"ACTIVE","contractId":"K-0N7RAK71","lastModifiedBy":"jsmith","lastModifiedDate":"2021-05-21T19:45:00Z","target":"example.com","type":"ALIAS","versionId":"19f38d0d-d8cb-4ac1-a7c9-ab8d82d8ca06","zone":"example.com"},{"activationState":"ERROR","aliasCount":1,"comment":"Initial add","contractId":"K-0N7RAK71","lastActivationDate":"2021-01-03T12:00:00Z","lastModifiedBy":"jperez","lastModifiedDate":"2021-12-11T03:21:00Z","masters":["192.0.2.215","192.0.2.37"],"signAndServe":false,"tsigKey":{"algorithm":"hmac-sha512","name":"other.com.akamai.com.","secret":"Ok1qR5IW1ajVka5cHPEJQIXfLyx5V3PSkFBROAzOn21JumDq6nIpoj6H8rfj5Uo+Ok55ZWQ0Wgrf302fDscHLw=="},"type":"SECONDARY","versionId":"7949b2db-ac43-4773-a3ec-dc93202142fd","zone":"other.com"}]}