Hanzo
OpenapiPlatform

Checks a custom domain's DNS and turns it on if it passes.

Checks a custom domain's DNS and turns it on if it passes.

POST /v1/platform/projects/{project}/apps/{app}/domains/{host}/verify

Addresshttps://api.hanzo.ai/v1/platform/projects/{project}/apps/{app}/domains/{host}/verify
MethodPOST
Operationpost_platform_projects_by_project_apps_by_app_domains_by_host_verify
AuthAuthorization: Bearer $HANZO_API_KEY

Checks a custom domain's DNS and turns it on if it passes.

It runs the DNS challenge check for a pending custom host and, when it passes, marks the host verified and renders it into the app's ingress so it starts serving.

A check that RAN and did not pass is not an error: it answers 200 with the host still pending and the reason in detail, so a console can show the operator what DNS is actually returning. An already-verified host answers as-is without re-checking. A host not claimed by this app is 404. Requires a validated principal; 403 without one.

Request

3 fields.

FieldInTypeRequiredDescription
projectpathstringyesProject is the project the application lives under, from the path.
apppathstringyesApp is the application's slug, from the path.
hostpathstringyesHost is the hostname, from the path.

Response

StatusBodyMeaning
200domainViewok

200 body — 12 fields.

FieldInTypeAlwaysDescription
createdAtbodyintegerCreatedAt is the unix second the custom claim was made.
detailbodystringDetail says why a claim is still pending, in the resolver's own words.
hostbodystringHost is the hostname itself.
kindbodystringKind is default, subtree or custom — how the org came to own it.
primarybodybooleanPrimary marks the app's permanent default host.
recordsbodyRecord[]Records are the DNS records to publish while a custom claim is pending.
records[].namebodystringthe record name the customer creates
records[].typebodystringTXT | CNAME
records[].valuebodystringthe record value
statusbodystringStatus is live, provisioning, pending_deploy or pending, derived from the operator CR and never fabricated.
urlbodystringURL is the host as an HTTPS address.
verifiedbodybooleanVerified is whether ownership is settled — always true for a host the org structurally owns.

Failure carries the platform error shape — see Errors.

Examples

hanzo platform projects apps domains verify <project> <app> <host>

Platform API · All Hanzo APIs · Interactive reference

How is this guide?

On this page