A valid request URL is required to generate request examples{
"connected": true,
"custom_domain_available": true,
"host": "accounts.example.com",
"status": "pending",
"status_detail": "<string>",
"verification": [
{
"type": "CNAME",
"domain": "<string>",
"value": "<string>",
"reason": "<string>"
}
],
"last_checked_at": "2023-11-07T05:31:56Z",
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Check the custom domain's DNS
Requires org:update. Asks the edge to look at DNS now, rather than waiting for its own schedule, and records what it said.
Ungated: a tenant on any plan whose DNS already points here has to be able to see whether it works.
Every status that is not verified names a different repair. pending means nothing answers for this host yet — add the records in verification. misconfigured means something answers and it is not us — remove or replace what is there. Telling somebody to add a record when a conflicting one already exists is a support thread that goes four rounds.
A 200 here means the check succeeded, not that the domain works: the result is in the body. Only a 503 means we could not ask — and then nothing is written, because a transient failure must never be recorded as your domain having broken.
A valid request URL is required to generate request examples{
"connected": true,
"custom_domain_available": true,
"host": "accounts.example.com",
"status": "pending",
"status_detail": "<string>",
"verification": [
{
"type": "CNAME",
"domain": "<string>",
"value": "<string>",
"reason": "<string>"
}
],
"last_checked_at": "2023-11-07T05:31:56Z",
"verified_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Cabeçalhos
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Parâmetros de caminho
The environment's id.
Resposta
What the edge said.
The address your customers reach the hosted portal at.
connected is false for an environment that has none, which is a state a screen renders rather than a 404 — and custom_domain_available still answers, because a screen has to know whether the capability exists on the server before it offers the form.
Every status that is not verified names a different repair.
Whether this environment has claimed a host. The fields below it are present only when true.
Whether the server can register a custom domain at all. False means connecting answers 501, whatever else is reported here.
"accounts.example.com"
pending: nothing answers for this host yet — add the records in verification. misconfigured: something answers and it is not us — remove or replace it. verified: nothing to do. Only an explicit yes from the edge ever reaches verified.
pending, misconfigured, verified Why it is not verified, in the edge's own words. Empty on a verified domain. Never parse it.
The DNS records to create. Stored as the edge described them rather than recomputed, because an apex takes an A record and a subdomain a CNAME — which one is not ours to decide.
Show child attributes
Show child attributes
When we last asked, whatever the answer — it moves even when the edge could not be reached, which is what separates "checked a minute ago" from "nobody has looked since Tuesday".
When it first answered yes. Kept through a later misconfigured: a domain that worked and stopped is a different problem from one that never worked.