Domains

AdminUpdated Sep 11, 2026

Backend API — secret key (Authorization: Bearer sk_…).

4 routes. Each row is one endpoint with its explanation, required scope, and whether it honours the Idempotency-Key header.

Method & path	Scope	Idem	Explanation
`GET /v1/domains`	`domains:read`		List custom domains with DNS/ACME/cookie-domain status and setup instructions.
`POST /v1/domains`	`domains:write`	✓	Claim a custom domain (fapi or accounts). Returns the CNAME instructions to follow.
`POST /v1/domains/:id/verify`	`domains:write`	✓	Check the domain's CNAME now; a verified fapi host is written onto the instance.
`DELETE /v1/domains/:id`	`domains:write`	✓	Remove a custom domain. Refused for a live production fapi host, which would sign everyone out.

Was this page helpful?