Skip to main content
GET
Get step-by-step setup/validation instructions for the tenant's custom domain
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

GET /domains/instructions Description: Returns a human-readable, current-state-aware guide for finishing domain setup (CNAME target, DNS TXT record or HTTP file challenge details, and completion status). Returns generic getting-started instructions if no domain has been configured yet. Authorization:
  • Required role: user or higher
Method: GET

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Response

Setup instructions retrieved

success
boolean
Example:

true

data
object