Skip to main content
You need a root key with the permissions listed on this page. Create one in the dashboard under Settings > Root Keys. See Permission reference for every permission.
Retrieve a custom domain by ID or name and its status. Names are unique per workspace, so api.acme.com is enough. No project, , or is needed. Use it to check progress after create-domain. We check DNS about once a minute.
  • status: verified means routing is set up and a certificate has been requested.
  • Each entry in dnsRecords has a verified flag, so you can see which records are still missing. A routing record your provider proxies or flattens can stay false even while it serves traffic.
  • verificationError explains the last failed check.
  • Verification stops 24 hours after createdAt, and the status becomes failed.

​
Usage

​
Flags

​
string
required
Domain ID or fully qualified name.

​
Shared flags

Every unkey api command accepts these; CLI output and shared flags describes them in full.
​
string
A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See Send a raw body.
​
string
Root key for the request. Falls back to UNKEY_ROOT_KEY, then to the config file written by unkey auth login. See CLI authentication.
​
string
default:"https://api.unkey.com"
Base URL of the API. Falls back to UNKEY_API_BASE_URL. You don’t normally need to set it.
​
string
default:"~/.unkey/config.toml"
Path of the TOML file that unkey auth login writes. Falls back to UNKEY_CONFIG.
​
string
Output format. Falls back to UNKEY_OUTPUT. Set json to print the full response envelope (meta and data) for piping; any other value prints the request ID followed by data.

​
Required permissions

Your root key needs one of:
  • environment.*.read_domain (any environment)
  • environment.<environment_id>.read_domain (a specific environment)
If the domain doesn’t exist or your key doesn’t have the permission, you get the same 404: The requested domain does not exist. See Root key permissions for the full catalog.

​
Examples

Check a domain:
Print only the status:

​
API endpoint

The command calls POST /v2/domains.getDomain and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape --body expects.

Custom domains

DNS records, verification, and certificates for your own hostnames.
Last modified on September 29, 2026