---
title: "List zones"
method: GET
path: "/v1/dns/zones"
tags: ["zones"]
---

# List zones

`GET /v1/dns/zones`

List a user's zones.
The type of the results can be selected using the `view` parameter.
Results can be filtered and sorted using the `filter` and `sort` parameters,
and filtered by `zone` metadata using metadata filter expressions.

## Query parameters

- `view` 'detail' | 'name_only' — Zone format (defaults to summary)
- `offset` integer
- `limit` integer
- `sort` object
  - `zone_name` 'asc' | 'desc'
  - `publication_state` 'asc' | 'desc'
- `filter` FilterZoneSummaryList — Filter options: (allowed fields: publication_state, is_shared, name, zone_type)
  - `publication_state` 'publish_requested' | 'published' | 'publish_failed' | 'unpublish_requested' | 'unpublished' — Publication state for zone
  - `is_shared` boolean, nullable
  - `zone_type` 'primary' | 'secondary' — Zone type
  - `zone_name` union
    - string
    - string[]
  - `dns_name` union
    - string
    - string[]
    - '*' | '!*'
  - `dns_type` union — DNS name type supported by API
    - 'A' | 'AAAA' | 'CAA' | 'CNAME' | 'MX' | 'NS' | 'SRV' | 'TXT' | 'PTR' | '_URL' | 'ALIAS' — DNS name type supported by API
    - DnsRecType[]
    - '*' | '!*'
  - `label` union
    - string
    - string[]
  - `rdata` union
    - string
    - string[]
    - '*' | '!*'
- `expand[]` string[]
- `metadata` string — A metadata filter expression See [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.

## Response `200`

zone data

- object — zone data
  - `data` union, required — zone data
    - ZoneDetail[]
      - union — DNS zone of authority
        - object — Zone summary, including group options.
          - `name` string, required — The name of the zone.
          - `zone_type` 'primary' | 'secondary', required — Zone type
          - `is_owner` boolean, required — Is the zone owned by the user?
          - `zone_authority` string — ## Identifier A string type that has a limited character set, which makes it useful as an easy to type identifier for use in things like URL paths. The restrictions are alphanumeric characters (Unicode is permitted), plus dashes and underscore except for the initial character.
          - `nx_ttl` integer, required — Negative caching (NXDOMAIN, etc) time-to-live (seconds)
          - `publication_state` 'publish_requested' | 'published' | 'publish_failed' | 'unpublish_requested' | 'unpublished', required — Publication state for zone
          - `publication_failure` string, nullable — Publication failure reason
          - `is_write_prohibited` boolean, required — Zone is write prohibited
          - `shared_in_group` string — ## Identifier A string type that has a limited character set, which makes it useful as an easy to type identifier for use in things like URL paths. The restrictions are alphanumeric characters (Unicode is permitted), plus dashes and underscore except for the initial character.
          - `dns_name_count` integer, nullable — Count of dns names in the zone.
          - `rdata_count` integer, nullable — Count of rdata in the zone.
          - `metadata` Metadata — A collection of string key/value pairs that provide additional information or classification for an object.
          - `created_at` string, date-time, required — Created at
          - `updated_at` string, date-time, required — Updated at
        - object — DNS zone of authority
          - `name` string, required — The name of the zone.
          - `zone_type` 'primary' | 'secondary', required — Zone type
          - `is_owner` boolean, required — Is the zone owned by the user?
          - `dns_name_count` integer, nullable — Count of dns names in the zone.
          - `rdata_count` integer, nullable — Count of rdata in the zone.
    - ZoneSummary[]
  - `page` PageInfo, required
    - `offset` integer, required
    - `limit` integer, required
    - `total` integer, required
  - `warnings` Warning[]
    - `code` string, required — A code for this warning.
    - `title` string, required — A title for this warning.
    - `detail` string, nullable — Contextual information about this warning.

## Other responses

- `401` — unauthorized (code: 2465)

---

[API](https://skmtc.net/noip/apis/no-ip-api.md) · [All operations](https://skmtc.net/noip/apis/no-ip-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/noip/no-ip-api/versions/619d78b2a70e/schema)