Get domain

Retrieve a custom domain and its verification status.

Address the domain by its id or by its name. Names are unique per workspace, so api.acme.com is sufficient. You do not need to supply a project, app, or environment.

Use this endpoint to poll after domains.createDomain. Verification runs in the background and checks DNS approximately each minute.

status: verified means the domain is verified. Unkey has configured routing and requested a certificate. Each entry in dnsRecords has a verified flag. The flag shows which records Unkey has read back, so you can see which records are still missing. Some providers hide a record from DNS lookups, for example a proxied or flattened routing record. Such a record stays false while it serves traffic. verificationError gives the reason for the last failed attempt.

dnsRecords contains the same values that domains.createDomain returned. Use it to recover the values without creating the domain again.

Important: verification stops 24 hours after the domain was created, and the status becomes failed. The window starts at createdAt, not at the last attempt.

Required Permissions

Your root key must have one of the following permissions:

environment.*.read_domain (to read domains in any environment)
environment.<environment_id>.read_domain (to read domains in a specific environment)

POST

domains.getDomain

Typescript (SDK)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.domains.getDomain({
    domain: "dom_1234abcd",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/domains.getDomain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "dom_1234abcd"
}
'

import requests

url = "https://api.unkey.com/v2/domains.getDomain"

payload = { "domain": "dom_1234abcd" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'dom_1234abcd'})
};

fetch('https://api.unkey.com/v2/domains.getDomain', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unkey.com/v2/domains.getDomain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'dom_1234abcd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unkey.com/v2/domains.getDomain"

	payload := strings.NewReader("{\n  \"domain\": \"dom_1234abcd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/domains.getDomain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"dom_1234abcd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/domains.getDomain")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"dom_1234abcd\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "appId": "app_1234abcd",
    "createdAt": 1704067200000,
    "dnsRecords": [
      {
        "name": "api.acme.com",
        "note": "Create as DNS-only if your provider offers the choice.",
        "ttl": 60,
        "type": "CNAME",
        "value": "a1b2c3d4e5f6g7h8.cname.unkey.com",
        "verified": false
      },
      {
        "name": "_unkey.api.acme.com",
        "note": "Proves ownership. Create it alongside the routing record.",
        "ttl": 60,
        "type": "TXT",
        "value": "unkey-domain-verify=3ZQ8xK1mP7vT5nR2wY6bJ4hL",
        "verified": false
      }
    ],
    "domain": "api.acme.com",
    "environmentId": "env_1234abcd",
    "id": "dom_1234abcd",
    "projectId": "proj_1234abcd",
    "status": "failed",
    "updatedAt": 1704153600000,
    "verificationError": "domain verification timed out after 24 hours"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

Authorizations

Authorization

string

header

required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

domain

string

required

Identifies a domain by its Unkey ID or by its name. Pass a 'dom_'-prefixed ID, or a fully qualified domain name such as 'api.acme.com' without a scheme, port, or path. You can give an internationalized name in Unicode or Punycode form. Both forms address the same domain.

Domain names are unique per workspace, so the name alone addresses the domain. You do not need to supply a project, app, or environment.

Required string length: 4 - 253

Example:

"api.acme.com"

Response

Successfully retrieved the domain.

meta

object

required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data

object

required

Show child attributes

Last modified on August 24, 2026

⌘I

Typescript (SDK)

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.domains.getDomain({
    domain: "dom_1234abcd",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/domains.getDomain \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "dom_1234abcd"
}
'

import requests

url = "https://api.unkey.com/v2/domains.getDomain"

payload = { "domain": "dom_1234abcd" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({domain: 'dom_1234abcd'})
};

fetch('https://api.unkey.com/v2/domains.getDomain', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unkey.com/v2/domains.getDomain",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'domain' => 'dom_1234abcd'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unkey.com/v2/domains.getDomain"

	payload := strings.NewReader("{\n  \"domain\": \"dom_1234abcd\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/domains.getDomain")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"domain\": \"dom_1234abcd\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/domains.getDomain")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"domain\": \"dom_1234abcd\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "appId": "app_1234abcd",
    "createdAt": 1704067200000,
    "dnsRecords": [
      {
        "name": "api.acme.com",
        "note": "Create as DNS-only if your provider offers the choice.",
        "ttl": 60,
        "type": "CNAME",
        "value": "a1b2c3d4e5f6g7h8.cname.unkey.com",
        "verified": false
      },
      {
        "name": "_unkey.api.acme.com",
        "note": "Proves ownership. Create it alongside the routing record.",
        "ttl": 60,
        "type": "TXT",
        "value": "unkey-domain-verify=3ZQ8xK1mP7vT5nR2wY6bJ4hL",
        "verified": false
      }
    ],
    "domain": "api.acme.com",
    "environmentId": "env_1234abcd",
    "id": "dom_1234abcd",
    "projectId": "proj_1234abcd",
    "status": "failed",
    "updatedAt": 1704153600000,
    "verificationError": "domain verification timed out after 24 hours"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}