Sign in
Zone RRSets

List RRSets

Returns all RRSets in the Zone.

Use the provided URI parameters to modify the result.

The maximum value for per_page on this endpoint is 100 instead of 50.

Only applicable for Zones in primary mode.

Operation specific errors

StatusCodeDescription
422incorrect_zone_modeThis operation is not supported for this Zone's mode.
get/zones/{id_or_name}/rrsets

Request

  • Base URL: https://api.hetzner.cloud/v1
  • URL: https://api.hetzner.cloud/v1/zones/{id_or_name}/rrsets
  • Auth: HTTP bearer

Path parameters

id_or_namestring required

ID or Name of the Zone.

ID or Name of the Zone.

Query parameters

namestring

Filter resources by their name.

The response will only contain the resources matching exactly the specified name.

typestring[]

Filter resources by their type. May be used multiple times.

The response will only contain resources matching the specified types.

[
  "A"
]
label_selectorstring

Filter resources by labels.

The response will only contain resources matching the label selector. For more information, see "Label Selector".

sortstring[]

Sort resources by field and direction. May be used multiple times.

For more information, see "Sorting".

pageinteger
Example:1

Page number to return. For more information, see "Pagination".

per_pageinteger
Example:25

Maximum number of entries returned per page. For more information, see "Pagination".

Response

Request succeeded.

Example response

{
  "rrsets": [
    {
      "name": "www",
      "type": "A",
      "ttl": 3600,
      "labels": {
        "environment": "prod",
        "example.com/my": "label",
        "just-a-key": ""
      },
      "records": [
        {
          "value": "198.51.100.1",
          "comment": "My web server at Hetzner Cloud."
        }
      ],
      "zone": 42
    }
  ],
  "meta": {
    "pagination": {
      "page": 3,
      "per_page": 25,
      "previous_page": 2,
      "next_page": 4,
      "last_page": 4,
      "total_entries": 100
    }
  }
}

Changes

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