API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Domains

AdminUpdated Sep 11, 2026

Domains

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

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

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/domains

Custom domains with CNAME instructions, TLS status and the cookie-domain check.

PUT /v1/dashboard/accounts/:accountId/instances/:instanceId/domains

Claim a hostname for the FAPI or hosted-pages role. Subdomains only.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/domains/:domainId/verify

Check the CNAME now and record what DNS actually returned.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/domains/:domainId

Remove a domain. Refused for a live production FAPI host.

Was this page helpful?