Get a domain

get https://api.linode.com/{apiVersion}/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.

linode-cli domains view 123


Learn more...

domains:read_only


Learn more...

Responses

Response body

object

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.

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

axfr_ips

description

string

length between 1 and 253

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

domain

string

length between 1 and 253

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

length between 1 and 50

deprecated

Filterable The group this Domain belongs to. This is for display purposes only.

integer

Read-only This Domain's unique ID.

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

Defaults to active

Used to control whether this Domain is currently being rendered.

disabled active

tags

ttl_sec

integer

Defaults to 0

"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.

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).

master slave

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.linode.com/v4/domains/domainId \
3
     --header 'accept: application/json'


xxxxxxxxxx
18
 
1
{
2
  "axfr_ips": [],
3
  "description": null,
4
  "domain": "example.org",
5
  "expire_sec": 300,
6
  "id": 1234,
7
  "master_ips": [],
8
  "refresh_sec": 300,
9
  "retry_sec": 300,
10
  "soa_email": "admin@example.org",
11
  "status": "active",
12
  "tags": [
13
    "example tag",
14
    "another example"
15
  ],
16
  "ttl_sec": 300,
17
  "type": "master"
18
}

200A single Domain in Linode's DNS Manager.

defaultSee Errors for the range of possible error response codes.