NOnoip
zones

List 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.

get/v1/dns/zones

Request

  • Base URL
    https://api.noip.com
  • URL
    https://api.noip.com/v1/dns/zones
  • Auth
    • HTTP bearer
    • or HTTP basic

Query parameters

view'detail' | 'name_only'

Zone format (defaults to summary)

Example:detail
offsetinteger

Offset from beginning of list

limitinteger

Maximum number of results to return

zone_name'asc' | 'desc'
publication_state'asc' | 'desc'

Sort options: (allowed fields: zone_name, publication_state; allowed sorting: asc, desc).

{
  "zone_name": "asc",
  "publication_state": "asc"
}
publication_state'publish_requested' | 'published' | 'publish_failed' | 'unpublish_requested' | 'unpublished'

Publication state for zone

is_sharedboolean nullable
zone_type'primary' | 'secondary'

Zone type

{
  "publication_state": "published",
  "is_shared": true,
  "zone_type": "primary",
  "zone_name": [
    "example-zone-a.com",
    "example-zone-b.com"
  ],
  "dns_name": [
    "www"
  ],
  "dns_type": [
    "A"
  ],
  "label": [
    "rdata-label"
  ],
  "rdata": [
    "192.0.2.1"
  ]
}
expand[]string[]

Sub-resource expansion options. (allowed resources: dns_name_count, rdata_count)

[
  "dns_name_count",
  "rdata_count"
]
metadatastring

A metadata filter expression See metadata filters for an in-depth description of the expression syntax.

Example:{"or":[{"and":[{"op":"contains","key":"key1","value":"value1"},{"op":"exact","key":"key2","value":"value2"}]},{"op":"exact","key":"key3","value":"value3"}]}

Filter results by metadata. See metadata filters for an in-depth description of the expression syntax.

Response

zone data

Example response

{
  "data": [
    {
      "name": "example.com",
      "zone_type": "primary",
      "metadata": {
        "property": "value"
      }
    }
  ],
  "page": {
    "total": 10
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.