Checks the DNS challenge for a pending custom hostname and, when it passes,…
Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge.
POST /v1/projects/{slug}/domains/{host}/verify
| Address | https://api.hanzo.ai/v1/projects/{slug}/domains/{host}/verify |
| Method | POST |
| Operation | post_projects_by_slug_domains_by_host_verify |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Checks the DNS challenge for a pending custom hostname and, when it passes, promotes the host so it begins routing at the edge.
It answers 200 either way, with the host's honest current state: verified once
the TXT record is found, still pending — with the records to publish and the
resolver's own explanation in detail — when it is not. A not-yet is not an
error: the check ran, DNS simply has not propagated, and the customer retries.
An already-verified host is returned unchanged without re-resolving. On a
successful promotion the edge cache-tag is flushed, since the host routes as
of that moment.
Scope: a validated principal is required (403 without one). Both the site and the claim are resolved within that principal's org, so a host claimed by another tenant is "not claimed by this site".
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
slug | path | string | yes | Slug is the project the host is attached to, from the path. |
host | path | string | yes | Host is the custom hostname, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | projectsDomain | ok |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
createdAt | body | integer | — | CreatedAt is when the host was claimed, as Unix seconds — not when it went live. |
detail | body | string | — | Detail is what is holding the claim up, in words a person can act on. |
host | body | string | — | Host is the custom hostname claimed for this site. |
records | body | Record[] | — | Records are EXACTLY the DNS records to publish to prove ownership and route the host. |
records[].name | body | string | — | the record name the customer creates |
records[].type | body | string | — | TXT | CNAME |
records[].value | body | string | — | the record value |
status | body | string | — | Status is live when the edge answers for this host now, pending while the claim is waiting on DNS proof of ownership. |
url | body | string | — | URL is where the host will serve once it is live — present on a pending claim too, so a console can show the destination before it works. |
verified | body | boolean | — | Verified is the same fact as a boolean, for a caller that only needs the yes or no. |
Failure carries the platform error shape — see Errors.
Examples
hanzo projects domains verify <slug> <host>import { Configuration, ProjectsApi } from 'hanzoai';
const api = new ProjectsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postProjectsBySlugDomainsByHostVerify({ slug: 'slug', host: 'host' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProjectsApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProjectsApi(client).post_projects_by_slug_domains_by_host_verify(slug='slug', host='host')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.ProjectsAPI.PostProjectsBySlugDomainsByHostVerify(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, projects_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = projects_api::post_projects_by_slug_domains_by_host_verify(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProjectsApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new ProjectsApi(client).postProjectsBySlugDomainsByHostVerify();curl -X POST https://api.hanzo.ai/v1/projects/<slug>/domains/<host>/verify \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches projects through the projects tool, which names its 48 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_projects"
}
}
}'How is this guide?