domains
Overview
| Name | domains |
| Type | Resource |
| Id | linode.domains.domains |
Fields
| Name | Datatype | Description |
|---|---|---|
id | integer | This Domain's unique ID |
description | string | A description for this Domain. This is for display purposes only. |
axfr_ips | array | 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. |
domain | string | 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. |
expire_sec | integer | 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. |
group | string | The group this Domain belongs to. This is for display purposes only. |
master_ips | array | 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. |
refresh_sec | integer | 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. |
retry_sec | integer | 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. |
soa_email | string | Start of Authority email address. This is required for type master Domains. |
status | string | Used to control whether this Domain is currently being rendered. |
tags | array | An array of tags applied to this object. Tags are for organizational purposes only. |
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 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. |
type | string | 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"). |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
getDomain | SELECT | domainId | This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers. |
getDomains | SELECT | This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers. | |
createDomain | INSERT | data__domain, data__type | Adds a new Domain to Linode's DNS Manager. Linode is not a registrar, and you must own the domain before adding it here. Be sure to point your registrar to Linode's nameservers so that the records hosted here are used. |
deleteDomain | DELETE | domainId | Deletes a Domain from Linode's DNS Manager. The Domain will be removed from Linode's nameservers shortly after this operation completes. This also deletes all associated Domain Records. |
_getDomain | EXEC | domainId | This is a single Domain that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for this Domain record to work you must own the domain and point your registrar at Linode's nameservers. |
_getDomains | EXEC | This is a collection of Domains that you have registered in Linode's DNS Manager. Linode is not a registrar, and in order for these to work you must own the domains and point your registrar at Linode's nameservers. | |
cloneDomain | EXEC | domainId, data__domain | Clones a Domain and all associated DNS records from a Domain that is registered in Linode's DNS manager. |
importDomain | EXEC | data__domain, data__remote_nameserver | Imports a domain zone from a remote nameserver. Your nameserver must allow zone transfers (AXFR) from the following IPs: - 96.126.114.97 - 96.126.114.98 - 2600:3c00::5e - 2600:3c00::5f |
updateDomain | EXEC | domainId | Update information about a Domain in Linode's DNS Manager. |