Domains
v4.176.0 List domains GET
https://api.linode.com/v4/domains
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.
Authorizations personalAccessToken oauth domains:read_only
Query Parameters page Type: integer
>=
1Default:
1
Default: 1 The page of a collection to return.
page_size Type: integer
25..500Default:
100
Default: 100 The number of items to return per page.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
Response Samples
200
default
{
"data" : [
{
"axfr_ips" : [],
"description" : null ,
"domain" : "example.org" ,
"expire_sec" : 300 ,
"group" : null ,
"id" : 1234 ,
"master_ips" : [],
"refresh_sec" : 300 ,
"retry_sec" : 300 ,
"soa_email" : "admin@example.org" ,
"status" : "active" ,
"tags" : [
"example tag" ,
"another example"
],
"ttl_sec" : 300 ,
"type" : "master"
}
],
"page" : 1 ,
"pages" : 1 ,
"results" : 1
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A paginated list of Domains you have registered.
array
of objects
array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
Read-only This Domain’s unique ID
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes
only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
integer
Read-only The current page .
integer
Read-only The total number of pages .
integer
Read-only The total number of results.
Error
array
of objects
string
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.
string
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.
Create a domain POST
https://api.linode.com/v4/domains
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.
Authorizations personalAccessToken oauth domains:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"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"],
"group": "Example Display Group",
"tags": ["tag1","tag2"]
}' \
linode-cli domains create \
\
\
Request Body Schema array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Response Samples
200
default
{
"axfr_ips" : [],
"description" : null ,
"domain" : "example.org" ,
"expire_sec" : 300 ,
"group" : null ,
"id" : 1234 ,
"master_ips" : [],
"refresh_sec" : 300 ,
"retry_sec" : 300 ,
"soa_email" : "admin@example.org" ,
"status" : "active" ,
"tags" : [
"example tag" ,
"another example"
],
"ttl_sec" : 300 ,
"type" : "master"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Domain added successfully.
array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
Read-only This Domain’s unique ID
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Error
array
of objects
string
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.
string
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.
Import a domain POST
https://api.linode.com/v4/domains/import
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 Authorizations personalAccessToken oauth domains:read_write
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"domain": "example.com",
"remote_nameserver": "examplenameserver.com"
}' \
linode-cli domains import --domain example.com --remote_nameserver examplenameserver.com
Request Body Schema string
The domain to import.
remote_nameserver
Required
string
The remote nameserver that allows zone transfers (AXFR).
Response Samples
200
default
{
"axfr_ips" : [],
"description" : null ,
"domain" : "example.org" ,
"expire_sec" : 300 ,
"group" : null ,
"id" : 1234 ,
"master_ips" : [],
"refresh_sec" : 300 ,
"retry_sec" : 300 ,
"soa_email" : "admin@example.org" ,
"status" : "active" ,
"tags" : [
"example tag" ,
"another example"
],
"ttl_sec" : 300 ,
"type" : "master"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A single Domain in Linode's DNS Manager.
array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
Read-only This Domain’s unique ID
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Error
array
of objects
string
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.
string
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.
Delete a domain DELETE
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 personalAccessToken oauth domains:read_write
Path Parameters domainId integer
Required The ID of the Domain to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
\
linode-cli domains delete 1234
Response Samples
200
default
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Domain deleted successfully.
Error
array
of objects
string
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.
string
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.
Get a domain GET
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 personalAccessToken oauth domains:read_only
Path Parameters domainId integer
Required The ID of the Domain to access.
Request Samples
Shell
CLI
curl -H "Authorization: Bearer $TOKEN " \
linode-cli domains view 123
Response Samples
200
default
{
"axfr_ips" : [],
"description" : null ,
"domain" : "example.org" ,
"expire_sec" : 300 ,
"group" : null ,
"id" : 1234 ,
"master_ips" : [],
"refresh_sec" : 300 ,
"retry_sec" : 300 ,
"soa_email" : "admin@example.org" ,
"status" : "active" ,
"tags" : [
"example tag" ,
"another example"
],
"ttl_sec" : 300 ,
"type" : "master"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A single Domain in Linode's DNS Manager.
array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
Read-only This Domain’s unique ID
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Error
array
of objects
string
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.
string
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.
Update a domain PUT
https://api.linode.com/v4/domains/{domainId}
Update information about a Domain in Linode’s DNS Manager.
Authorizations personalAccessToken oauth domains:read_write
Path Parameters domainId integer
Required The ID of the Domain to access.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"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"],
"group": "Example Display Group",
"tags": ["tag1","tag2"]
}' \
linode-cli domains update 1234 \
7200 \
300
Request Body Schema array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Response Samples
200
default
{
"axfr_ips" : [],
"description" : null ,
"domain" : "example.org" ,
"expire_sec" : 300 ,
"group" : null ,
"id" : 1234 ,
"master_ips" : [],
"refresh_sec" : 300 ,
"retry_sec" : 300 ,
"soa_email" : "admin@example.org" ,
"status" : "active" ,
"tags" : [
"example tag" ,
"another example"
],
"ttl_sec" : 300 ,
"type" : "master"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
Domain update successful.
array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
Read-only This Domain’s unique ID
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Error
array
of objects
string
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.
string
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.
Clone a domain POST
https://api.linode.com/v4/domains/{domainId}/clone
Clones a Domain and all associated DNS records from a Domain that is registered in Linode’s DNS manager.
Authorizations personalAccessToken oauth domains:read_write
Path Parameters domainId string
Required ID of the Domain to clone.
Request Samples
Shell
CLI
curl -H "Content-Type: application/json" \
"Authorization: Bearer $TOKEN " \
'{
"domain": "example.com"
}' \ https://api.linode.com/v4/domains/123/clone
linode-cli domains clone 123 --domain example.com
Request Body Schema string
1..253
characters
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.
Response Samples
200
default
{
"axfr_ips" : [],
"description" : null ,
"domain" : "example.org" ,
"expire_sec" : 300 ,
"group" : null ,
"id" : 1234 ,
"master_ips" : [],
"refresh_sec" : 300 ,
"retry_sec" : 300 ,
"soa_email" : "admin@example.org" ,
"status" : "active" ,
"tags" : [
"example tag" ,
"another example"
],
"ttl_sec" : 300 ,
"type" : "master"
}
{
"errors" : [
{
"field" : "fieldname" ,
"reason" : "fieldname must be a valid value"
}
]
}
Responses
200
default
A new Domain in Linode's DNS Manager, based on a cloned Domain.
array
of strings
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.
string
1..253
characters
A description for this Domain. This is for display purposes only.
string
1..253
characters
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.
integer
The amount of time in seconds that may pass before this Domain is no longer authoritative.
Valid values are 0, 30, 120, 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.
string
1..50
characters
The group this Domain belongs to. This is for display purposes only.
integer
Read-only This Domain’s unique ID
array
of strings
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.
integer
The amount of time in seconds before this Domain should be refreshed.
Valid values are 0, 30, 120, 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.
integer
The interval, in seconds, at which a failed refresh should be retried.
Valid values are 0, 30, 120, 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.
string<email>
Start of Authority email address. This is required for type master Domains.
stringEnum:
disabled
active
Default:
active
Used to control whether this Domain is currently being rendered.
array
of strings
An array of tags applied to this object. Tags are for organizational purposes only.
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, 30, 120, 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. stringEnum:
master
slave
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”).
Error
array
of objects
string
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.
string
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.
