Domains

List connected domains.

Cursor-paginated and workspace-scoped. Pass hostname for an exact-match lookup instead of paging the whole workspace.

get/v1/domains

Request

  • Base URL: https://api.domainee.dev
  • URL: https://api.domainee.dev/v1/domains
  • Auth: HTTP bearer

Query parameters

hostnamestring
Example:app.acme.com

Exact hostname to look up. Returns at most one domain and a null nextCursor.

status'pending' | 'verified' | 'failed' | 'expired'

Only return domains in this verification state.

cursorstring

The nextCursor from a previous page.

limitinteger

Page size.

Response

A page of domains.

nextCursorstring nullable required

Null on the last page.

Example response

{
  "domains": [
    {
      "id": "dom_9f2c",
      "hostname": "app.acme.com",
      "originUrl": "https://acme.vercel.app",
      "dnsRecords": [
        {
          "name": "app.acme.com",
          "value": "edge.domainee.dev",
          "type": "CNAME",
          "purpose": "Traffic Routing"
        }
      ],
      "dnsRecordOptions": [
        {
          "label": "A records",
          "records": [
            {
              "name": "app.acme.com",
              "value": "edge.domainee.dev",
              "type": "CNAME",
              "purpose": "Traffic Routing"
            }
          ]
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.