DomaineeDocs
Domains

List domains

GET /v1/domains — paginated list of every domain in your workspace.

GET /v1/domains

Returns every domain in the workspace tied to your API key. Cursor-paginated.

Request

curl https://api.domainee.dev/v1/domains \
  -H "Authorization: Bearer $DOMAINEE_API_KEY"

Query parameters

ParamNotes
statusFilter: pending · verified · failed · expired
hostnameExact-match lookup (case-insensitive). Returns at most one domain; nextCursor is always null. Saves you paging the whole workspace when you only need one domain.
limit1–200, default 50
cursorPagination cursor from a previous nextCursor

Looking up by hostname

curl "https://api.domainee.dev/v1/domains?hostname=shop.acme.com" \
  -H "Authorization: Bearer $DOMAINEE_API_KEY"

Empty domains array if no match — never a 404.

Response — 200 OK

{
  "domains": [
    {
      "id": "8f09b47c-b42f-4d14-8395-2989db76e6f8",
      "hostname": "shop.acme.com",
      "originUrl": "https://acme.fly.dev",
      "status": "verified",
      "mode": "proxy",
      "monitorStatus": "active_ssl",
      "metadata": { "orderId": "ord_123", "tenant": "acme" },
      "verifiedAt": "2026-05-05T11:39:19.406Z",
      "createdAt": "2026-05-05T11:39:12.884Z"
    }
  ],
  "nextCursor": "8f09b47c-b42f-4d14-8395-2989db76e6f8"
}

Whatever you stored in metadata at create time round-trips on every list — useful for stitching domains back to your own records (workspace, tenant, customer id, etc.) without a separate lookup table.

nextCursor is null once you've reached the last page. Pass it back as ?cursor=... to get the following page.

The Domain object

Full field reference for the objects returned in domains[]:

FieldTypeNotes
idstringUUID. Use it on GET/PATCH/DELETE.
hostnamestringThe customer's hostname. Lowercase, RFC-1123.
originUrlstringURL we forward to (proxy mode) or redirect to (redirect mode).
statusenumpending · verified · failed · expired. Driven by DNS state.
modeenumproxy (default) — reverse-proxy traffic. redirect — return 301/302.
keepHostbooleanproxy mode only: forward customer's Host header instead of rewriting.
redirectWwwbooleanIf true, also issue cert for the www variant and 301 it to canonical.
redirectStatus301 | 302HTTP code for redirect mode.
dnsRecordsarrayThe records the customer must publish.
isResolvingbooleanWhether DNS resolves the hostname at all.
pointsToEdgebooleanWhether DNS points to our edge IPs.
dnsPointedAtstring[]Snapshot of resolved IPs from last probe.
monitorStatusenumComputed health. See Monitor states.
monitorMessagestringHuman-readable explanation of monitorStatus.
metadataobjectWhatever you sent on Create, echoed back verbatim. Useful for keying domains to records on your side.
verifiedAtstring | nullWhen DNS first pointed at our edge.
createdAtstringISO 8601 timestamp.
updatedAtstringISO 8601 timestamp.

On this page