List domains

List the custom domains attached to an environment and their verification status.

Results are paginated and sorted by their id. When hasMore is true, send the returned cursor to get the next page. An environment with no domains returns an empty array, not a 404.

status: verified means the domain is verified. Unkey has configured routing and requested a certificate. Each domain includes its full dnsRecords. Each record has a verified flag. The flag shows which records Unkey has read back, so you can see which records are still missing without a second call. 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.

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 /v2/domains.listDomains

Typescript (SDK)

TypeScript

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

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

async function run() {
  const result = await unkey.domains.listDomains({
    project: "proj_1234abcd",
    app: "app_1234abcd",
    environment: "env_1234abcd",
  });

  console.log(result);
}

run();

200

domainList

{ "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": true }, { "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": "verified", "updatedAt": 1704067260000 }, { "appId": "app_1234abcd", "createdAt": 1704067200000, "dnsRecords": [ { "name": "acme.com", "note": "Apex domains cannot hold a CNAME. Use ALIAS, ANAME, or a flattened CNAME depending on your provider.", "ttl": 60, "type": "ALIAS", "value": "i9j8k7l6m5n4o3p2.cname.unkey.com", "verified": false }, { "name": "_unkey.acme.com", "note": "Proves ownership. An apex domain cannot be verified through its routing record, so this is the only proof available.", "ttl": 60, "type": "TXT", "value": "unkey-domain-verify=7Kp2Rq9wZx4mB6nT1yL8vJ3h", "verified": true } ], "domain": "acme.com", "environmentId": "env_1234abcd", "id": "dom_5678efgh", "projectId": "proj_1234abcd", "status": "verified", "updatedAt": 1704067260000 } ], "meta": { "requestId": "req_1234abcd" }, "pagination": { "hasMore": false } }

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

project · string · required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

app · string · required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

environment · string · required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

limit · integer · default: 100

The maximum number of domains one response contains. A small limit makes the response smaller, but makes more requests necessary.

Required range: 1 <= x <= 100

cursor · string

The pagination cursor from the response that came before. Send it to get the next page when that response has hasMore: true.

Example:

"dom_1234abcd"

search · string

Free-form text to filter domains. Returns domains whose ID or name contains the search string. Matching is case-insensitive.

Maximum string length: 256

Example:

"acme.com"

Response

200

application/json

Successfully retrieved the environment's domains.

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

The domains attached to the environment, sorted by their id. The array is empty when the environment has no domains. This is not an error.

Maximum array length: 100

Show child attributes

pagination · object · required

Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.

Show child attributes