Domains
View Domain
https://api.linode.com/v4/domains/{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.
Authorizations
Path Parameters
The ID of the Domain to access.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
https://api.linode.com/v4/domains/123
Response Samples
- 200
- default
{
"id": 1234,
"status": "active",
"domain": "example.org",
"type": "master",
"group": "",
"description": "",
"soa_email": "admin@example.org",
"retry_sec": 300,
"master_ips": [],
"axfr_ips": [],
"expire_sec": 300,
"refresh_sec": 300,
"ttl_sec": 300,
"tags": []
}Responses
200: A single Domain in Linode's DNS Manager.
This Domain's unique ID
Used to control whether this Domain is currently being rendered.
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.
If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).
The group this Domain belongs to. This is for display purposes only.
A description for this Domain. This is for display purposes only.
Start of Authority email address. This is required for master Domains.
The interval, in seconds, at which a failed refresh should be retried. 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 IP addresses representing the master DNS for this Domain.
The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
The amount of time in seconds that may pass before this Domain is no longer authoritative. 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 amount of time in seconds before this Domain should be refreshed. 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.
"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 will be rounded to the nearest valid value.
- ttl_sec will default to 0 if no value is provided.
- A value of 0 is equivalent to a value of 86400.
An array of tags applied to this object. Tags are for organizational purposes only.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
Update Domain
https://api.linode.com/v4/domains/{domainId}Update information about a Domain in Linode's DNS Manager.
Authorizations
Path Parameters
The ID of the Domain to access.
Request Body Schema
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.
If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).
The list of IPs that may perform a zone transfer for this Domain. 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 amount of time in seconds that may pass before this Domain is no longer authoritative. 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 group this Domain belongs to. This is for display purposes only.
The IP addresses representing the master DNS for this Domain.
The amount of time in seconds before this Domain should be refreshed. 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 interval, in seconds, at which a failed refresh should be retried. 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.
Start of Authority email address. This is required for 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 will be rounded to the nearest valid value.
- ttl_sec will default to 0 if no value is provided.
- A value of 0 is equivalent to a value of 86400.
Request Samples
- Shell
- CLI
curl -H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-X PUT -d '{
"domain": "example.com",
"type": "master",
"soa_email": "admin@example.com",
"description": "Example Description",
"refresh_sec": 14400,
"retry_sec": 3600,
"expire_sec": 604800,
"ttl_sec": 3600,
"status": "active",
"master_ips": ["127.0.0.1","255.255.255.1","123.123.123.7"],
"axfr_ips": ["44.55.66.77"],
"display_group": "Example Display Group"
}' \
https://api.linode.com/v4/domains/123
Response Samples
- 200
- default
{
"id": 1234,
"status": "active",
"domain": "example.org",
"type": "master",
"group": "",
"description": "",
"soa_email": "admin@example.org",
"retry_sec": 300,
"master_ips": [],
"axfr_ips": [],
"expire_sec": 300,
"refresh_sec": 300,
"ttl_sec": 300,
"tags": []
}Responses
200: Domain update successful.
This Domain's unique ID
Used to control whether this Domain is currently being rendered.
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.
If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).
The group this Domain belongs to. This is for display purposes only.
A description for this Domain. This is for display purposes only.
Start of Authority email address. This is required for master Domains.
The interval, in seconds, at which a failed refresh should be retried. 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 IP addresses representing the master DNS for this Domain.
The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.
The amount of time in seconds that may pass before this Domain is no longer authoritative. 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 amount of time in seconds before this Domain should be refreshed. 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.
"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 will be rounded to the nearest valid value.
- ttl_sec will default to 0 if no value is provided.
- A value of 0 is equivalent to a value of 86400.
An array of tags applied to this object. Tags are for organizational purposes only.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.
Delete Domain
https://api.linode.com/v4/domains/{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.
Authorizations
Path Parameters
The ID of the Domain to access.
Request Samples
- Shell
- CLI
curl -H "Authorization: Bearer $TOKEN" \
-X DELETE \
https://api.linode.com/v4/domains/1234
Response Samples
- 200
- default
{}Responses
200: Domain deleted successfully.
default: Error
What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.
The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.