List zone records

This endpoint allows you to list the DNS records of a specific zone.
Many results can be returned, so a pagination system is provided with the limit and offset parameters.
You can also use filters to search for specific records.

Endpoint

GET /dns/v3/zones/{zonename}/records

Parameters

Name	Location	Required	Type	Default value	Description
zonename	URL	Yes	String		The zone name
limit	URL	No	Integer		Number of DNS records to return
offset	URL	No	Integer	0	Offset used
sort	URL	No	String	name	Field used to sort DNS records. Allowed values : name, type
name	URL	No	String		Search by DNS record name. Use @ to search for records at the zone apex. Wildcard compatible
type	URL	No	String		Search by DNS record type. Wildcard compatible
data	URL	No	String		Search by DNS record content. Wildcard compatible
comment	URL	No	String		Search by comment. Wildcard compatible
tag	URL	No	String		Search by the name of a tag. Wildcard compatible
tag_value	URL	No	String		Search by the value of a tag. Wildcard compatible
show_updates	URL	No	Boolean	false	Display record creations, modifications and deletions awaiting validation

Response

A RecordSearchResults object.

Example Request

GET /dns/v3/zones/example.com/records?limit=3&offset=2&name=@&comment="test"

Example Response

{
    "message": "OK",
    "data": {
        "total": 10,
        "limit": 3,
        "offset": 2,
        "results": [
            {
                "id": "55555",
                "name": "",
                "type": "A",
                "data": "192.168.0.0",
                "ttl": 3600,
                "created_at": "2021-01-01T16:48:27.000000Z",
                "modified_at": "2021-01-01T16:48:27.000000Z",
                "modified_by": "Paul SMITH",
                "comment": {
                    "value": "test",
                    "modified_at": "2021-01-01T16:48:27.000000Z",
                    "modified_by": "Paul SMITH"
                }
            },
            {
                "id": "55566",
                "name": "",
                "type": "MX",
                "data": "10 mx3.nameshield.com",
                "created_at": "2021-01-01T16:48:27.000000Z",
                "modified_at": "2021-01-03T10:42:25.000000Z",
                "modified_by": "James Darwin",
                "comment": {
                    "value": "test",
                    "modified_at": "2021-01-03T10:42:25.000000Z",
                    "modified_by": "James Darwin"
                },
                "tags": [
                    {
                        "tag": "ref",
                        "value": "4782",
                        "created_at": "2021-01-02T11:02:28.000000Z",
                        "created_by": "John Doe"
                    }
                ]
            }
        ]
    }
}