Domains

List a site's custom domains

Every hostname connected to (or being connected to) the site, with its status and the DNS records still to create. Hostnames that are not connected yet carry a live DNS check on each record. Stale external hostnames are re-checked with Cloudflare in the background, so a poll sees fresher data next time. Needs the site owner. Editors, viewers, guest tokens (guest_requires_account) and keys scoped to other sites are refused.

get/api/v1/sites/{slug}/custom-domains

Request

  • Base URL: https://api.dotsy.ai
  • URL: https://api.dotsy.ai/api/v1/sites/{slug}/custom-domains
  • Auth: HTTP bearer

Path parameters

slugstring required
Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Response

The site's domains.

Example response

{
  "domains": [
    {
      "host": "www.example.com",
      "slug": "acme-studio",
      "kind": "external",
      "status": "pending_dns",
      "isPrimary": false,
      "lastError": null,
      "createdAt": 1760000000000,
      "verifiedAt": 1760000000000,
      "connectSessionId": "cs_3f9a1c2e",
      "lastCheckedAt": 1760000000000,
      "dnsRecords": [
        {
          "type": "CNAME",
          "name": "www",
          "value": "customers.dotsy.site",
          "purpose": "routing",
          "recordStatus": "missing"
        },
        {
          "type": "TXT",
          "name": "_acme-challenge.www",
          "value": "k3Zr1q9Wn0xLpV7sT2uYb8cD4eFgH6jA",
          "purpose": "dcv",
          "recordStatus": "waiting"
        }
      ]
    }
  ]
}

Changes

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