List zones

get

https://{hostname}/config-dns/v2/zones

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

Read the definitions of the current zone activation status (activationState) here.

Query Params

contractIds

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

string

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.

subzoneGrants

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

string

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

integer

Defaults to 1

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

pageSize

integer

Defaults to 25

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

showAll

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.

accountSwitchKey

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

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Zones that you own.