---
title: "List DNS names"
method: GET
path: "/v1/dns/records"
tags: ["records"]
---

# List DNS names

`GET /v1/dns/records`

Lists the dns names of the user.
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`, `name` and `rrset` metadata using metadata filter expressions.

## Query parameters

- `view` 'summary' | 'record' — Record format (defaults to summary)
- `offset` integer
- `limit` integer
- `sort` object
  - `zone_name` 'asc' | 'desc'
  - `name` 'asc' | 'desc'
  - `name_labels_reversed` 'asc' | 'desc'
  - `dns_type` 'asc' | 'desc'
  - `rdata` 'asc' | 'desc'
  - `label` 'asc' | 'desc'
  - `zone_is_shared` 'asc' | 'desc'
  - `created_at` 'asc' | 'desc'
- `filter` FilterDnsNameList — Filter options: (allowed fields: name, zone_name, dns_type, zone_is_shared, dynupdate)
  - `dns_name` union
    - string
    - string[]
  - `zone_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[]
    - '*' | '!*'
  - `zone_is_shared` boolean, nullable
  - `update_group` union — Name of the update group
    - string — Name of the update group
    - GroupName[]
    - '*' | '!*'
  - `dynupdate` boolean, nullable
  - `label` union
    - string
    - string[]
  - `rdata` union
    - string
    - string[]
    - '*' | '!*'
- `expand[]` string[]
- `zone_metadata` string — A metadata filter expression See [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.
- `metadata` string — A metadata filter expression See [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.
- `rrset_metadata` string — A metadata filter expression See [metadata filters](metadata-filter-expressions) for an in-depth description of the expression syntax.

## Response `200`

DNS name data

- object — DNS name data
  - `data` union, required — DNS name data
    - DnsNameSummary[]
      - `fqdn` string, required — The FQDN that results from this name and its zone
    - DnsNameRecord[]
      - `metadata` Metadata — A collection of string key/value pairs that provide additional information or classification for an object.
      - `rrset_metadata` MetadataField — A metadata field.
        - `metadata` Metadata — A collection of string key/value pairs that provide additional information or classification for an object.
      - `zone_metadata` MetadataField — A metadata field.
        - `metadata` Metadata — A collection of string key/value pairs that provide additional information or classification for an object.
      - `name` string, required — The DNS name, not including the zone portion.
      - `update_group` string — Name of the update group
      - `record` Record — DNS resource name
        - `dns_type` 'A' | 'AAAA' | 'CAA' | 'CNAME' | 'MX' | 'NS' | 'SRV' | 'TXT' | 'PTR' | '_URL' | 'ALIAS', required — DNS name type supported by API
        - `rdata` string, required — Rdata value
        - `label` string, required — Rdata label
        - `update_group` string — Name of the update group
        - `ttl` integer, required
        - `updated_at` string, date-time, required — Updated at
      - `zone_name` string, required — The name of the zone.
      - `is_write_prohibited` boolean, required — Name is write prohibited
      - `zone_is_shared` boolean, required — Is the zone shared?
      - `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.
      - `name_labels_reversed` string, required — Name with the labels in reverse order
      - `created_at` string, date-time, required — Created at
  - `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

- `400` — invalid sort key (code: 4251)
- `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)