> ## Documentation Index
> Fetch the complete documentation index at: https://unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# unkey api domains list-domains

> List the custom domains in your workspace with their status.

<Note>
  You need a root key with the permissions listed on this page. Create one in the dashboard under **Settings > Root Keys**. See [Permission reference](/docs/platform/root-keys/permissions-legacy) for every permission.
</Note>

List the custom domains in your workspace with their <Tooltip tip="Here: proving DNS ownership of a custom domain. Not key verification.">verification</Tooltip> status and `dnsRecords`. Results are sorted by ID and paginated. When `pagination.hasMore` is true, pass `pagination.cursor` back with `--cursor`. Add `--output=json` to see the `pagination` object.

Every filter is optional. With none, you get every domain in the workspace. `--project`, `--app`, and `--environment` each narrow the list, and the most specific one wins. A filter that matches nothing returns an empty list, not a 404. In large workspaces, use filters: if a page would need to look through more than 10,000 domains, the call fails with 503 and `The domain scan limit was reached. Narrow the project, app, environment, or search filters and retry.`

## Usage

```bash theme={"system"}
unkey api domains list-domains [--project=<project>] [--app=<app>] [--environment=<environment>] [--limit=<n>] [--cursor=<cursor>] [--search=<text>]
```

## Flags

<ParamField body="--app" type="string">
  App ID or slug to filter by.
</ParamField>

<ParamField body="--cursor" type="string">
  Pagination cursor from a previous response.
</ParamField>

<ParamField body="--environment" type="string">
  Environment ID or slug to filter by.
</ParamField>

<ParamField body="--limit" type="integer" default="100">
  Maximum domains per page, from 1 to 100.
</ParamField>

<ParamField body="--project" type="string">
  Project ID or slug to filter by. Both forms resolve to the same project.
</ParamField>

<ParamField body="--search" type="string">
  Case-insensitive filter on domain ID or name.
</ParamField>

### Shared flags

Every `unkey api` command accepts these; [CLI output and shared flags](/docs/platform/cli/output-and-flags) describes them in full.

<ParamField body="--body" type="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](/docs/platform/cli/output-and-flags#send-a-raw-body).
</ParamField>

<ParamField body="--root-key" type="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](/docs/platform/cli/authentication).
</ParamField>

<ParamField body="--api-url" type="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.
</ParamField>

<ParamField body="--config" type="string" default="~/.unkey/config.toml">
  Path of the TOML file that `unkey auth login` writes. Falls back to `UNKEY_CONFIG`.
</ParamField>

<ParamField body="--output" type="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`.
</ParamField>

## Required permissions

Your root key needs the workspace-wide `environment.*.read_domain`. A grant for one environment doesn't work here.

A key without the permission isn't rejected. It gets an empty list instead of a 403, so an empty result doesn't always mean you have no domains. See [Root key permissions](/docs/platform/root-keys/permissions) for the full catalog.

## Examples

List every domain in the workspace:

```bash theme={"system"}
unkey api domains list-domains
```

List the domains of one environment:

```bash theme={"system"}
unkey api domains list-domains --project=payments --app=api --environment=production
```

Filter and page:

```bash theme={"system"}
unkey api domains list-domains --project=payments --app=api --environment=production --limit=25 --search=acme.com
```

## API endpoint

The command calls [`POST /v2/domains.listDomains`](/docs/compute/api-reference/domains/list-domains) and prints its response. The request fields carry the same names as the flags in camelCase, which is the shape `--body` expects.

## Related

<Columns cols={1}>
  <Card title="Custom domains" href="/docs/compute/networking/custom-domains">
    DNS records, verification, and certificates for your own hostnames.
  </Card>
</Columns>