Agent-readable docs index: /docs/llms.txt. Full docs in one file: /docs/llms-full.txt. Download /docs/docs.zip to grep all markdown files locally.

Custom Domains API Endpoints

Manage branded custom domains programmatically.

1. Add Custom Domain

POST /api/v1/domains
Registers a new hostname under your active organization workspace and initiates SSL certificate issuance with Cloudflare for SaaS.

Request Payload:

{
  "domain": "link.yourbrand.com",
  "rootRedirectUrl": "https://yourbrand.com",
  "notFoundRedirectUrl": "https://yourbrand.com/404"
}

2. List Workspace Domains

GET /api/v1/domains
Returns all verified and pending domains configured in the organization, including their current DNS verification and SSL certificate statuses.

Response Example:

{
  "code": 0,
  "data": [
    {
      "id": "dom_abc123",
      "domain": "link.yourbrand.com",
      "status": "active",
      "sslStatus": "active",
      "cnameTarget": "cname.shaf.app",
      "rootRedirectUrl": "https://yourbrand.com",
      "createdAt": "2026-09-19T12:00:00.000Z"
    }
  ]
}

3. Trigger DNS Re-Verification

POST /api/v1/domains/:id/verify
Forces an immediate DNS lookup across global resolvers and re-checks SSL certificate issuance progress.

4. Delete Custom Domain

DELETE /api/v1/domains/:id
Decommissions the custom hostname from the edge network and releases the TLS certificate.