Custom Domain Kit
Docs/API

Domains API

Domains API

Domains represent customer hostnames under an application.

List Domains

GET /v1/applications/:applicationId/domains

Create Domain

POST /v1/applications/:applicationId/domains
Content-Type: application/json

{
  "hostname": "docs.customer.com",
  "tenantId": "tenant_456",
  "actorId": "user_789"
}

tenantId is required. actorId is optional but recommended for audit trails.

Get Domain

GET /v1/applications/:applicationId/domains/:domainId

Refresh Domain Status

GET /v1/applications/:applicationId/domains/:domainId/status

Use this when support staff or your backend needs a fresh status outside the embedded setup UI.

Create Setup Session for an Existing Domain

GET /v1/applications/:applicationId/domains/:domainId/setup-session

Returns a short-lived setup session for the domain's tenant.

Delete Domain

DELETE /v1/applications/:applicationId/domains/:domainId

Returns 204 No Content.

Store the Response

Persist domainId, hostname, tenantId, status, and statusReason in your product so support, runtime routing, and webhook updates all refer to the same row.