Skip to main content
GET
Get a server's domain name

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string | null
required

The server uuid short

Example:

"ecc6f4f1"

Response

The record, as a JSON object. There is no envelope.

The server's own domain name, which points at one of its IP addresses while it is switched on.

name
string
required

The name, such as vps-1a2b3c4d.my-advin.com. It is the same whether or not it is switched on.

Example:

"vps-ecc6f4f1.my-advin.com"

enabled
boolean
required

The value of enabled.

Example:

true

address_id
integer | null
required

The address picked for the name, or null when it follows the primary IP.

Example:

null

ip_address
string | null
required

The IP the name points at, or null while it is switched off.

Example:

"203.0.113.24"

status
enum<string> | null
required

Whether the nameserver has caught up with the name, or null while it is switched off.

Available options:
pending,
synced,
failed,
null
Example:

"synced"

error
string | null
required

The value of error.

Example:

null