Domains /
Get subdomain
Gets details about the given subdomain
Required permission
Account > Domains > General > Read
Path parameters
domain
string requiredName of the domain
subdomain
string requiredName of the subdomain
Response body
- {object}
Response object.
data
{object} requiredResult data.
recordType
string requiredThe record type to use for the DNS record to verify the subdomain - always CNAME for subdomains.
name
string requiredThe subdomain.
fullName
string requiredThe full domain name with subdomain
content
string requiredThe content to set the DNS record to
verified
boolean requiredWhether the subdomain has been verified successfully and can be used.
API
CLI
JS Client
GET /v1/domains/{domain}/subdomains/{subdomain}
Example response
200 OK
Details about the subdomain.
JSON
{
"data": {
"recordType": "CNAME",
"name": "site",
"fullName": "site.example.com",
"content": "site.example.com.user-1234.dns.northflank.app",
"verified": true
}
}