Hanzo
OpenapiProjects

Returns every custom hostname this site holds: the live ones, plus any pending…

Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.

GET /v1/projects/{slug}/domains

Addresshttps://api.hanzo.ai/v1/projects/{slug}/domains
MethodGET
Operationget_projects_by_slug_domains
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every custom hostname this site holds: the live ones, plus any pending claim with the DNS records it still owes.

domains is the routing answer — the hosts that are verified right now — while claims is the full panel, one row per host, each saying whether it is live or pending and, if pending, exactly what to publish.

Scope: a validated principal is required (403 without one) and the site is resolved within that principal's org, so another tenant's slug is a 404.

Request

1 field.

FieldInTypeRequiredDescription
slugpathstringyesSlug is the project to act on, from the path.

Response

StatusBodyMeaning
200projectsDomainsok

200 body — 14 fields.

FieldInTypeAlwaysDescription
claimsbodyprojectsDomain[]Claims is one row per host — live, or pending with the DNS records it still owes.
claims[].createdAtbodyintegerCreatedAt is when the host was claimed, as Unix seconds — not when it went live.
claims[].detailbodystringDetail is what is holding the claim up, in words a person can act on.
claims[].hostbodystringHost is the custom hostname claimed for this site.
claims[].recordsbodyRecord[]Records are EXACTLY the DNS records to publish to prove ownership and route the host.
claims[].records[].namebodystringthe record name the customer creates
claims[].records[].typebodystringTXT | CNAME
claims[].records[].valuebodystringthe record value
claims[].statusbodystringStatus is live when the edge answers for this host now, pending while the claim is waiting on DNS proof of ownership.
claims[].urlbodystringURL 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.
claims[].verifiedbodybooleanVerified is the same fact as a boolean, for a caller that only needs the yes or no.
domainsbodystring[]Domains are the hostnames that are VERIFIED and routing right now.
orgbodystringOrg is the organisation that owns the site.
slugbodystringSlug is the site the panel belongs to.

Failure carries the platform error shape — see Errors.

Examples

hanzo projects domains list <slug>

Projects API · All Hanzo APIs · Interactive reference

How is this guide?

On this page