Domains v4.78.3

Domains List

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 >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Domain Create

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 Body Schema

axfr_ips
array

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.

description
string 1..255 characters

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

domain
Filterable
Required
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 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

group
Filterable
string 1..50 characters

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.

refresh_sec
integer

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.

retry_sec
integer

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.

soa_email
string <email>

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

status
string
Enum: disabled active

Used to control whether this Domain is currently being rendered.

tags
Filterable
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 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.

type
Required
string
Enum: 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”).

Request Samples

Response Samples

Responses

Domain Import

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 Body Schema

domain
Required
string

The domain to import.

remote_nameserver
Required
string

The remote nameserver that allows zone transfers (AXFR).

Request Samples

Response Samples

Responses

Domain Delete

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

Response Samples

Responses

Domain View

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

Response Samples

Responses

Domain Update

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 Body Schema

axfr_ips
array

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.

description
string 1..255 characters

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

domain
Filterable
Required
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 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

group
Filterable
string 1..50 characters

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.

refresh_sec
integer

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.

retry_sec
integer

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.

soa_email
string <email>

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

status
string
Enum: disabled active

Used to control whether this Domain is currently being rendered.

tags
Filterable
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 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.

type
Required
string
Enum: 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”).

Request Samples

Response Samples

Responses

Domain Clone

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 Body Schema

domain
Required
string

The new domain being created.

Request Samples

Response Samples

Responses

Domain Records List

GET https://api.linode.com/v4/domains/{domainId}/records

Returns a paginated list of Records configured on a Domain in Linode’s DNS Manager.

Authorizations

personalAccessToken
oauth domains:read_only

Path Parameters

domainId integer Required

The ID of the Domain we are accessing Records for.

Query Parameters

page
Type:
integer >= 1
Default:
1

The page of a collection to return.

page_size
Type:
integer 25..100
Default:
100

The number of items to return per page.

Request Samples

Response Samples

Responses

Domain Record Create

POST https://api.linode.com/v4/domains/{domainId}/records

Adds a new Domain Record to the zonefile this Domain represents.

Authorizations

personalAccessToken
oauth domains:read_write

Path Parameters

domainId integer Required

The ID of the Domain we are accessing Records for.

Request Body Schema

name
string 1..100 characters

The name of this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the subdomain being associated with an IP address.

port
integer 0..65535

The port this Record points to.

priority
integer 0..255

The priority of the target host. Lower values are preferred.

protocol
Nullable
string

The protocol this Record’s service communicates with. Only valid for SRV records.

service
Nullable
string

The service this Record identified. Only valid for SRV records.

tag
Filterable
Nullable
string

The tag portion of a CAA record. It is invalid to set this on other record types.

target
string

The target for this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the address the named Domain should resolve to.

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
Required
string
Enum: A AAAA NS MX CNAME TXT SRV PTR CAA

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.

weight
integer 0..65535

The relative weight of this Record. Higher values are preferred.

Request Samples

Response Samples

Responses

Domain Record Delete

DELETE https://api.linode.com/v4/domains/{domainId}/records/{recordId}

Deletes a Record on this Domain.

Authorizations

personalAccessToken
oauth domains:read_write

Path Parameters

domainId integer Required

The ID of the Domain whose Record you are accessing.

recordId integer Required

The ID of the Record you are accessing.

Request Samples

Response Samples

Responses

Domain Record View

GET https://api.linode.com/v4/domains/{domainId}/records/{recordId}

View a single Record on this Domain.

Authorizations

personalAccessToken
oauth domains:read_only

Path Parameters

domainId integer Required

The ID of the Domain whose Record you are accessing.

recordId integer Required

The ID of the Record you are accessing.

Request Samples

Response Samples

Responses

Domain Record Update

PUT https://api.linode.com/v4/domains/{domainId}/records/{recordId}

Updates a single Record on this Domain.

Authorizations

personalAccessToken
oauth domains:read_write

Path Parameters

domainId integer Required

The ID of the Domain whose Record you are accessing.

recordId integer Required

The ID of the Record you are accessing.

Request Body Schema

name
string 1..100 characters

The name of this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the subdomain being associated with an IP address.

port
integer 0..65535

The port this Record points to.

priority
integer 0..255

The priority of the target host. Lower values are preferred.

protocol
Nullable
string

The protocol this Record’s service communicates with. Only valid for SRV records.

service
Nullable
string

The service this Record identified. Only valid for SRV records.

tag
Filterable
Nullable
string

The tag portion of a CAA record. It is invalid to set this on other record types.

target
string

The target for this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the address the named Domain should resolve to.

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
Enum: A AAAA NS MX CNAME TXT SRV PTR CAA

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.

weight
integer 0..65535

The relative weight of this Record. Higher values are preferred.

Request Samples

Response Samples

Responses