Domains /
Get domain
Gets details about domain
Required permission
Account > Domains > General > Read
Path parameters
domain
string requiredName of the domain
Response body
- {object}
Response object.
data
{object} requiredResult data.
name
string requiredThe domain name.
status
string requiredThe status of the domain verification.
one ofpending, verifiedhostname
string requiredThe hostname to add to your domain's DNS records as a TXT record to verify the domain.
token
string requiredThe token to add as the content of the TXT record to verify the domain.
subdomains
[array] requiredA list of subdomains added to this domain.
- {object}
Details about a subdomain.
name
string requiredThe subdomain added, or -default for the empty subdomain.
fullName
string requiredThe full domain including the subdomain.
API
CLI
JS Client
GET /v1/domains/{domain}
Example response
200 OK
Details about the given domain.
JSON
{
"data": {
"name": "example.com",
"status": "verified",
"hostname": "nfverify1608026055",
"token": "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57",
"subdomains": [
{
"name": "app",
"fullName": "app.example.com"
}
]
}
}