records

Overview

Name	records
Type	Resource
Id	linode.domains.records

Fields

Name	Datatype	Description
id	integer	This Record's unique ID.
name	string	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. 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).
created	string	When this Domain Record was created.
port	integer	The port this Record points to. Only valid and required for SRV record requests.
priority	integer	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.
protocol	string	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.
service	string	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.
tag	string	The tag portion of a CAA record. Only valid and required for CAA record requests.
target	string	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. To create a Null MX Record, first remove any additional MX records, 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. Required. 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 be a valid domain. 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.
ttl_sec	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.
type	string	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.
updated	string	When this Domain Record was last updated.
weight	integer	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.

Methods

Name	Accessible by	Required Params	Description
getDomainRecord	SELECT	domainId, recordId	View a single Record on this Domain.
getDomainRecords	SELECT	domainId	Returns a paginated list of Records configured on a Domain in Linode's DNS Manager.
createDomainRecord	INSERT	domainId, data__type	Adds a new Domain Record to the zonefile this Domain represents. Each domain can have up to 12,000 active records.
deleteDomainRecord	DELETE	domainId, recordId	Deletes a Record on this Domain.
_getDomainRecord	EXEC	domainId, recordId	View a single Record on this Domain.
_getDomainRecords	EXEC	domainId	Returns a paginated list of Records configured on a Domain in Linode's DNS Manager.
updateDomainRecord	EXEC	domainId, recordId	Updates a single Record on this Domain.