---
title: "List custom domains"
method: GET
path: "/customdomains"
tags: ["customdomains"]
---

# List custom domains

`GET /customdomains`

Returns all custom domains configured in the workspace. Custom domains allow serving preview deployments under your own domain (e.g., preview.yourdomain.com).

## Response `200`

successful operation

- CustomDomain[]
  - `metadata` CustomDomainMetadata, required — Owner fields for Persistence
    - `createdAt` string — The date and time when the resource was created
    - `updatedAt` string — The date and time when the resource was updated
    - `createdBy` string — The user or service account who created the resource
    - `updatedBy` string — The user or service account who updated the resource
    - `displayName` string — Display name for the custom domain
    - `labels` MetadataLabels — Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy.
    - `name` string — Domain name (e.g., "example.com")
    - `sharedFromWorkspace` string — If this custom domain is shared from another workspace of the same account, this field contains the name of the source (owning) workspace. Empty for owned domains.
    - `workspace` string — Workspace name
  - `spec` CustomDomainSpec, required — Custom domain specification
    - `cnameRecords` string — CNAME target for the domain
    - `domainType` 'previews' | 'applications' — Type of custom domain (previews or applications)
    - `fallbackPreviewId` string — Preview ID to route to when a preview lookup fails on this custom domain
    - `lastVerifiedAt` string — Last verification attempt timestamp
    - `region` string — Region that the custom domain is associated with
    - `status` 'pending' | 'verified' | 'failed' — Current status of the domain (pending, verified, failed)
    - `subjectAlternativeNames` object[] — Subject Alternative Names (SANs) for the ACM certificate. Only applicable for application domains.
    - `txtRecords` object — Map of TXT record names to values for domain verification
    - `verificationError` string — Error message if verification failed

---

[API](https://skmtc.net/blaxel/apis/blaxel-control-plane.md) · [All operations](https://skmtc.net/blaxel/apis/blaxel-control-plane/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blaxel/blaxel-control-plane/revisions/dfa264bc72ee/schema)