Sign in
DNS - Zones

List DNS Zones

List all DNS Zones owned by your account.

get/workspace/dns/zones

Query parameters

activeboolean

Filter by active status.

domainstring

Filter by domain (exact match).

fieldsstring

Comma-separated list of field names to include in the response. Nested fields can be accessed using dot notation.

namestring

Filter by name (exact match).

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

A numeric value that indicates the number of items per page.

searchstring

A search term.

Response

List of DNS zones retrieved successfully.

countinteger

Total number of items

total_pagesinteger

Total number of pages

pageinteger

Current page number

page_sizeinteger

Number of items per page

nextstring uri nullable

URL to the next page of results

previousstring uri nullable

URL to the previous page of results

Example response

{
  "count": 123,
  "total_pages": 10,
  "page": 1,
  "page_size": 10,
  "next": "https://api.example.com/items?page=3",
  "previous": "https://api.example.com/items?page=1"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.