Domains

Apply DNS records through the DNS provider's API

The paste-credentials lane for providers with an API (Name.com, GoDaddy): verifies the credentials, stores them encrypted, and writes the routing and certificate-check records for every host in the host's connect session. Omit credentials to reuse the ones saved earlier. External hosts only; an already connected host just returns its row. If it fails, the manual records from getCustomDomainConnect still work. Needs the site owner. Editors, viewers, guest tokens (guest_requires_account) and keys scoped to other sites are refused.

post/api/v1/sites/{slug}/custom-domains/{host}/provider-connect

Request

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

hoststring required
Example:www.example.com

The hostname, e.g. www.example.com. Case-insensitive.

Request body

credentialsobject

The provider credentials, keyed by the providerApi.fields[].key the connect response listed (Name.com: username + token; GoDaddy: pat). Dotsy verifies them, stores them encrypted, and applies the records. Omit them to reuse the credentials saved from a previous connect.

Example request

{
  "credentials": {
    "pat": "YOUR_GODADDY_PERSONAL_ACCESS_TOKEN"
  }
}

Response

Records applied (or the host was already connected).

Example response

{
  "domain": {
    "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"
      }
    ]
  },
  "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.