List domains

List your custom domains with their verification status and DNS records. Filter by project, app, or environment using IDs or slugs, or send {} to list domains across your workspace.

Use any filter on its own or combine filters to narrow the results. Results match all supplied filters. Omitting environment includes all matching environments.

Results include only domains you have permission to read, sorted by ID. When hasMore is true, send the returned cursor to get the next page.

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

Use a root key with the environment.*.read_domain permission. A successful request returns an empty list if no matching domains are readable by your key.

POST

domains.listDomains

Go (SDK)

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v3"
	"github.com/unkeyed/sdks/api/go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Domains.ListDomains(ctx, components.V2DomainsListDomainsRequestBody{
        App: unkey.Pointer("payments-api"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2DomainsListDomainsResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.domains.list_domains(project="proj_1234abcd", app="payments-api", environment="proj_1234abcd", limit=100, cursor="dom_1234abcd", search="acme.com")

    while res is not None:
        # Handle items

        res = res.next()

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

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

async function run() {
  const result = await unkey.domains.listDomains({
    app: "payments-api",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

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

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

fetch('https://api.unkey.com/v2/domains.listDomains', 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.listDomains",
  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([
    'app' => 'payments-api'
  ]),
  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;
}

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

require 'uri'
require 'net/http'

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

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  \"app\": \"payments-api\"\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": 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

Filter domains within a workspace. All filters are optional and combine with AND. Each resource filter matches its ID or slug directly, even when its parent filters are omitted. A missing resource or a resource that does not match the other filters produces an empty list.

project

string

Match domains whose project ID or slug equals this value. This filter does not require an app or environment filter.

Required string length: 3 - 255

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

Example:

"proj_1234abcd"

app

string

Match domains whose app ID or slug equals this value. This filter does not require a project or environment filter.

Required string length: 3 - 255

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

Example:

"proj_1234abcd"

environment

string

Match domains whose environment ID or slug equals this value. This filter does not require a project or app filter.

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"

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

Successfully retrieved the permitted domains that match every filter. Missing or mismatched filtered resources return an empty list.

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

Domains that match every request filter and that you have permission to read, sorted by ID. The array is empty when no readable domains match, including when a filtered resource is missing or mismatched.

Maximum array length: 100

Show child attributes

pagination

object

required

Pagination over permitted domains. When more permitted domains exist, cursor identifies the first permitted domain after this page. A domain the credential cannot read is never returned as the cursor.

Show child attributes

⌘I

Go (SDK)

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v3"
	"github.com/unkeyed/sdks/api/go/v3/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Domains.ListDomains(ctx, components.V2DomainsListDomainsRequestBody{
        App: unkey.Pointer("payments-api"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2DomainsListDomainsResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.domains.list_domains(project="proj_1234abcd", app="payments-api", environment="proj_1234abcd", limit=100, cursor="dom_1234abcd", search="acme.com")

    while res is not None:
        # Handle items

        res = res.next()

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

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

async function run() {
  const result = await unkey.domains.listDomains({
    app: "payments-api",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

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

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

fetch('https://api.unkey.com/v2/domains.listDomains', 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.listDomains",
  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([
    'app' => 'payments-api'
  ]),
  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;
}

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

require 'uri'
require 'net/http'

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

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  \"app\": \"payments-api\"\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": 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
  }
}

Projects

Apps

Environments

Deployments

Domains

Gateway

GitHub

Analytics

List domains

Authorizations

Body

Response