Sign in

v1

latestOpenAPI 3.1.12026-07-17111158225.7 KB
zones

List zone records

Lists the records for a zone.

get/{account}/zones/{zone}/records

Path parameters

accountinteger required

The account id

zonestring required

The zone name

Query parameters

name_likestring

Only include results with a name field containing the given string

namestring

Only include results with a name field exactly matching the given string

typestring

Only include results with a type field exactly matching the given string

sort'id:asc' | 'id:desc' | 'name:asc' | 'name:desc' | 'content:asc' | 'content:desc' | 'type:asc' | 'type:desc'

Sort results. Default sorting is by name ascending.

Response

Successfully retrieved zone records list.

Example response

{
  "data": [
    {
      "id": 1,
      "zone_id": "example.com",
      "parent_id": null,
      "name": "",
      "content": "ns1.dnsimple.com admin.dnsimple.com 1458642070 86400 7200 604800 300",
      "ttl": 3600,
      "priority": null,
      "type": "SOA",
      "regions": [
        "global"
      ],
      "system_record": true,
      "created_at": "2016-03-22T10:20:53Z",
      "updated_at": "2016-10-05T09:26:38Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 30,
    "total_entries": 2,
    "total_pages": 1
  }
}