Domains

Get the next step to connect pending domains

Resumes (or starts) the connect session for the site's pending external hostnames and says what to do next: open a link, enter the listed DNS records, or wait. Pass the sessionId from addCustomDomain to resume that session. connect is null when every external hostname on the site is already connected. Runs live DNS checks unless you send live=0. 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/connect

Request

Base URL: https://api.dotsy.ai
URL: https://api.dotsy.ai/api/v1/sites/{slug}/custom-domains/connect
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.

Query parameters

sessionIdstring

The connect session id (cs_…) from connect.sessionId. Omit to resume the newest pending session.

live'0' | '1'

Live DNS and nameserver checks run by default. Send 0 to skip them and answer from the stored snapshot (cheap page loads).

Response

The connect state.

Example response

{
  "connect": {
    "sessionId": "cs_3f9a1c2e",
    "kind": "manual",
    "summary": "Add 2 DNS records at Namecheap, then check again.",
    "instructions": [
      "Add a CNAME record: Name \"www\" → Value \"customers.dotsy.site\"."
    ],
    "records": [
      {
        "type": "CNAME",
        "name": "www",
        "value": "customers.dotsy.site",
        "purpose": "routing",
        "host": "www.example.com",
        "recordStatus": "missing"
      }
    ],
    "provider": {
      "id": "namecheap",
      "label": "Namecheap"
    },
    "entriAvailable": false,
    "lane": "manual",
    "sessionStatus": "in_progress",
    "hosts": [
      {
        "host": "www.example.com",
        "status": "pending_dns",
        "isPrimary": false
      }
    ]
  }
}

Changes

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