List domain records

Returns a paginated list of Records configured on a Domain in Linode's DNS Manager.

Permissions and scopes

To call this operation, you need permissions, based on the model you're using:

  • Identity and access permissions. Your user needs a role with these permissions. Learn more.

    • Roles: domain_viewer
  • OAuth scopes. Your user needs these scopes assigned. Learn more.

    • Scopes: domains:read_only

CLI

linode-cli domains records-list 1234

Learn more

Path Params
string
enum
required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:
integer
required

The ID of the Domain we are accessing Records for.

Query Params
integer
≥ 1
Defaults to 1

The page of a collection to return.

integer
25 to 500
Defaults to 100

The number of items to return per page.

Response

Response body
object
data
array of objects
data
object
date-time

Read-only When this Domain Record was created.

integer

Read-only This Record's unique ID.

string
length between 1 and 100

Filterable The name of this Record. For requests, this property's actual usage and whether it is required depends on the type of record this represents:

A and AAAA: The hostname or FQDN of the Record.

NS: The subdomain, if any, to use with the Domain of the Record. Wildcard NS records (*) are not supported.

MX: The mail subdomain. For example, sub for the address user@sub.example.com under the example.com Domain.

  • The left-most subdomain component may be an asterisk (*) to designate a wildcard subdomain.
  • Other subdomain components must only contain letters, digits, and hyphens, start with a letter, end with a letter or digit, and contain less than 64 characters.
  • Must be an empty string ("") for a Null MX Record.

CNAME: The hostname. Must be unique. Required.

TXT: The hostname.

SRV: Unused. Use the service property to set the service name for this record.

CAA: The subdomain. Omit or enter an empty string ("") to apply to the entire Domain.

PTR: See our guide on how to Configure Your Linode for Reverse DNS
(rDNS)
.

integer
0 to 65535

The port this Record points to. Only valid and required for SRV record requests.

integer
0 to 255

The priority of the target host for this Record. Lower values are preferred. Only valid for MX and SRV record requests. Required for SRV record requests.

Defaults to 0 for MX record requests. Must be 0 for Null MX records.

string | null

The protocol this Record's service communicates with. An underscore (_) is prepended automatically to the submitted value for this property. Only valid for SRV record requests.

string | null

The name of the service. An underscore (_) is prepended and a period (.) is appended automatically to the submitted value for this property. Only valid and required for SRV record requests.

string | null
enum

Filterable The tag portion of a CAA record. Only valid and required for CAA record requests.

issue issuewild iodef

string
length ≤ 65535

Filterable The target for this Record. For requests, this property's actual usage and whether it is required depends on the type of record this represents:

A and AAAA: The IP address. Use [remote_addr] to submit the IPv4 address of the request. Required.

NS: The name server. Must be a valid domain. Required.

MX: The mail server. Must be a valid domain unless creating a Null MX Record. Required.

  • Must have less than 254 total characters.
  • The left-most domain component may be an asterisk (*) to designate a wildcard domain.
  • Other domain components must only contain letters, digits, and hyphens, start with a letter, end with a letter or digit, and contain less than 64 characters.
  • To create a Null MX Record, first remove any additional MX records, then create an MX record with empty strings ("") for the target and name. If a Domain has a Null MX record, new MX records cannot be created.

CNAME: The alias. Must be a valid domain. Required.

TXT: The value. Required.

SRV: The target domain or subdomain. If a subdomain is entered, it is automatically used with the Domain.
To configure for a different domain, enter a valid FQDN. For example, the value www with a Domain for
example.com results in a target set to www.example.com, whereas the value sample.com results in a
target set to sample.com. Required.

CAA: The value. For issue or issuewild tags, the domain of your certificate issuer. For the iodef
tag, a contact or submission URL (domain, http, https, or mailto). Requirements depend on the tag for this record:

  • issue: The domain of your certificate issuer. Must include a valid domain. May include additional parameters separated with semicolons (;), for example: www.example.com; foo=bar
  • issuewild: The domain of your wildcard certificate issuer. Must be a valid domain and must not start with an asterisk (*).
  • iodef: Must be either (1) a valid domain, (2) a valid domain prepended with http:// or https://, or (3) a valid email address prepended with mailto:.

PTR: Required. See our guide on how to Configure Your Linode for Reverse DNS
(rDNS)
.

With the exception of A, AAAA, and CAA records, this field accepts a trailing period.

integer

"Time to Live" - the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

string
enum

Filterable The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. For more information, see the guides on DNS Record Types.

A AAAA NS MX CNAME TXT SRV PTR CAA

date-time

Read-only When this Domain Record was last updated.

integer
0 to 65535

The relative weight of this Record used in the case of identical priority. Higher values are preferred. Only valid and required for SRV record requests.

integer

Read-only The current page.

integer

Read-only The total number of pages.

integer

Read-only The total number of results.

Language
Credentials