List zones

All zones that the current user has access to manage. The response is paginated.

Query Params
string

Limits the list to those zones belonging to the specified contracts.

string

Limits the list to those zones whose name matches the specified search string.

sortBy
array of strings

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.

sortBy
boolean
Defaults to false

If included, limits the Edge DNS zones where subzoneGrants matches the specified boolean. Refer to Subzone grants for more information.

types
array of strings

Limits the list to one or more Edge DNS zone types. Specify any combination of PRIMARY, SECONDARY, and ALIAS values.

types
Allowed:
integer
Defaults to 1

Which page of results to return. The first page is page 1, the default value.

integer
Defaults to 25

The number of results per page to return, 25 by default.

boolean
Defaults to false

Disables paging and sorting and shows the entire list all at once, false by default. Using this parameter may significantly increase the response time.

activationStates
array of strings

Limits the list to zones in the specified activation states. Specify any combination of ACTIVE, NEW, PENDING, LOCKED, and ERROR values.

activationStates
Allowed:
dnsSecStatus
array of strings

Limits the list to zones with the specified DNSSEC status. Specify any combination of valid, warning, and error values.

dnsSecStatus
Allowed:
transferStatus
array of strings

Limits the list to zones matching the specified zone transfer status. Specify any combination of success, warning, failure, and pending values.

transferStatus
Allowed:
string

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.

Response

Language
URL
LoadingLoading…
Response
Choose an example:
application/json