Create a domain

post

https://api.linode.com/{apiVersion}/domains

Adds a new domain to DNS Manager. You must own the domain before adding it here. Be sure to point your registrar to our nameservers. Akamai Cloud does not act as a registrar.

Permissions and scopes

To call this operation, you need the following:

Identity and access permissions. Your user needs these roles assigned. Learn more.
- Roles: account_domain_creator
OAuth scopes. Your user needs these scopes assigned. Learn more.
- Scopes: domains:read_write

CLI

linode-cli domains create \
  --type master \
  --domain example.org \
  --soa_email admin@example.org

Learn more

Path Params

apiVersion

string

enum

required

Enum Call either the v4 URL, or v4beta for operations still in Beta.

Allowed:

Body Params

A domain zonefile in our DNS system. You must own the domain name and tell your registrar to use Linode's nameservers in order for a domain in our system to be treated as authoritative.

axfr_ips

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.

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

axfr_ips

description

string | null

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

domain

string

required

length between 1 and 253

^(\*\.)?([a-zA-Z0-9-_]{1,63}\.)+([a-zA-Z]{2,3}\.)?([a-zA-Z]{2,16}|xn--[a-zA-Z0-9]+)$

Filterable 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

Defaults to 0

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.

group

string | null

deprecated

Deprecated, Filterable The group this domain belongs to. This is for display purposes only.

master_ips

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.

master_ips

refresh_sec

integer

Defaults to 0

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.

retry_sec

integer

Defaults to 0

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.

soa_email

string

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

status

string

enum

Defaults to active

Indicates whether this domain is currently being rendered, either active or disabled.

Allowed:

200Domain added successfully.

defaultSee Errors for the range of possible error response codes.