v1beta
Double column
curl
API
CLI

Domains /

Get domain details

Gets details about domain

URL parameters

    • domain

      string required

      Name of the domain

Response attributes

  • object

    • name

      string required

      The domain name.

    • status

      string required

      The status of the domain verification.

      one of: pending, verified

    • hostname

      string required

      The hostname to add to your domain's DNS records as a TXT record to verify the domain.

    • token

      string required

      The token to add as the content of the TXT record to verify the domain.

    • subdomains

      array required

      A list of subdomains added to this domain.

      • object

        Details about a subdomain.

        • name

          string required

          The subdomain added, or -default for the empty subdomain.

        • fullName

          string required

          The full domain including the subdomain.

API
CLI

GET /v1beta/domains/{domain}

Example response

200 OK

Details about the given domain.

JSON

{
  "name": "example.com",
  "status": "verified",
  "hostname": "nfverify1608026055",
  "token": "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57",
  "subdomains": [
    {
      "name": "app",
      "fullName": "app.example.com"
    }
  ]
}

© 2021 Northflank Ltd. All rights reserved.

TermsPrivacy

contact@northflank.com