Domainee Docs

API overview

Base URL, request format, and the resources exposed by the Domainee REST API.

The Domainee REST API runs at:

https://api.domainee.dev/v1

All requests are JSON over HTTPS, authenticated with a Bearer token. See Authentication for the key format and how to send it.

Resources

ResourceWhat it represents
DomainsCustomer hostnames routed through our edge to your origins.
Webhook endpointsURLs we POST to when domain events fire.
Webhook eventsEvent types and payload shapes.
DNS checksOn-demand DNS lookups for verifying customer records.

Conventions

  • All timestamps are ISO 8601 (UTC), e.g. 2026-05-05T11:39:19.406Z.
  • All ids are UUIDv4 strings.
  • application/json is the only supported content type for request bodies.
  • Errors share the shape { "error": "<code>", "message": "...", "details": {...} } — see Errors for the full reference.

Quick example

curl https://api.domainee.dev/v1/domains \
  -H "Authorization: Bearer $DOMAINEE_API_KEY"
{
  "domains": [
    {
      "id": "8f09b47c-b42f-4d14-8395-2989db76e6f8",
      "hostname": "shop.acme.com",
      "originUrl": "https://acme.fly.dev",
      "status": "verified",
      "monitorStatus": "active_ssl"
    }
  ],
  "nextCursor": null
}

On this page