Domains v4.166.0

Type:

integer >= 1

Default: 1

Default:

1

The page of a collection to return.

Type:

integer 25..500

Default: 100

Default:

100

The number of items to return per page.

The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters.

Note: This is potentially dangerous, and should be set to an empty list unless you intend to use it.

A description for this Domain. This is for display purposes only.

The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to RFC1035. Domains must be unique on Linode’s platform, including across different Linode accounts; there cannot be two Domains representing the same domain.

The amount of time in seconds that may pass before this Domain is no longer authoritative.

• Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

• Any other value is rounded up to the nearest valid value.

• A value of 0 is equivalent to the default value of 1209600.

The group this Domain belongs to. This is for display purposes only.

The IP addresses representing the master DNS for this Domain. At least one value is required for type slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.

The amount of time in seconds before this Domain should be refreshed.

• Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

• Any other value is rounded up to the nearest valid value.

• A value of 0 is equivalent to the default value of 14400.

The interval, in seconds, at which a failed refresh should be retried.

• Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

• Any other value is rounded up to the nearest valid value.

• A value of 0 is equivalent to the default value of 14400.

Start of Authority email address. This is required for type master Domains.

Used to control whether this Domain is currently being rendered.

An array of tags applied to this object. Tags are for organizational purposes only.

“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 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
• Any other value is rounded up to the nearest valid value.
• A value of 0 is equivalent to the default value of 86400.

Whether this Domain represents the authoritative source of information for the domain it describes (“master”), or whether it is a read-only copy of a master (“slave”).

The domain to import.

The remote nameserver that allows zone transfers (AXFR).

The list of IPs that may perform a zone transfer for this Domain. The total combined length of all data within this array cannot exceed 1000 characters.

Note: This is potentially dangerous, and should be set to an empty list unless you intend to use it.

A description for this Domain. This is for display purposes only.

The domain this Domain represents. Domain labels cannot be longer than 63 characters and must conform to RFC1035. Domains must be unique on Linode’s platform, including across different Linode accounts; there cannot be two Domains representing the same domain.

The amount of time in seconds that may pass before this Domain is no longer authoritative.

• Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

• Any other value is rounded up to the nearest valid value.

• A value of 0 is equivalent to the default value of 1209600.

The group this Domain belongs to. This is for display purposes only.

The IP addresses representing the master DNS for this Domain. At least one value is required for type slave Domains. The total combined length of all data within this array cannot exceed 1000 characters.

The amount of time in seconds before this Domain should be refreshed.

• Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

• Any other value is rounded up to the nearest valid value.

• A value of 0 is equivalent to the default value of 14400.

The interval, in seconds, at which a failed refresh should be retried.

• Valid values are 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.

• Any other value is rounded up to the nearest valid value.

• A value of 0 is equivalent to the default value of 14400.

Start of Authority email address. This is required for type master Domains.

Used to control whether this Domain is currently being rendered.

An array of tags applied to this object. Tags are for organizational purposes only.

“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 0, 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200.
• Any other value is rounded up to the nearest valid value.
• A value of 0 is equivalent to the default value of 86400.

Whether this Domain represents the authoritative source of information for the domain it describes (“master”), or whether it is a read-only copy of a master (“slave”).

The new domain for the clone. Domain labels cannot be longer than 63 characters and must conform to RFC1035. Domains must be unique on Linode’s platform, including across different Linode accounts; there cannot be two Domains representing the same domain.

Type:

integer >= 1

Default: 1

Default:

1

The page of a collection to return.

Type:

integer 25..500

Default: 100

Default:

100

The number of items to return per page.

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 asterix (*) 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).

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

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.

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.

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.

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

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 asterix (*) 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.

“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.

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.

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.

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 asterix (*) 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).

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

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.

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.

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.

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

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 asterix (*) 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.

“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.

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.