TEASEDocs
API ReferenceLandings

Trigger custom-domain verification

Run the DNS-verify probe for a connecting custom domain and, when DNS is green, transition it to `active`. Requires a write-scoped key.

Authorization

bearerAuth
AuthorizationBearer <token>

Your al_live_<prefix>_<secret> API key. Mint and manage keys in the dashboard.

In: header

Path Parameters

domain_id*integer

The numeric id of the connecting domain.

Response Body

application/json

application/json

application/json

POST
/api/admin/domains/{domain_id}/verify
curl -X POST "https://example.com/api/admin/domains/0/verify"
{  "hostname": "go.creator.com",  "state": "active"}
{  "detail": "auth required"}
{  "detail": {    "code": "domain_not_found",    "message": "Domain not found"  }}

Connect a custom domain

Begin connecting a custom domain: registers a pending domain and returns the DNS instructions the customer must apply. First step of the connect state machine (enter to instructions to verify to active). Requires a write-scoped key.

List geo-segments for a domain

List the draft geo-segments for a domain, ordered by position. A segment buckets visitors by country (with optional device/OS/time/language conditions) and owns an ordered button stack. Requires a read-scoped key.