Hanzo
OpenapiPlatform

Returns every hostname this app answers on.

Returns every hostname this app answers on.

GET /v1/platform/projects/{project}/apps/{app}/domains

Addresshttps://api.hanzo.ai/v1/platform/projects/{project}/apps/{app}/domains
MethodGET
Operationget_platform_projects_by_project_apps_by_app_domains
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every hostname this app answers on.

It lists the app's hosts: the permanent default host it was born with, any org-subtree hosts attached to it, and every custom host claimed for it with its verification state and, while pending, the DNS challenge records to publish. Live endpoint status for each host is observed from the cluster. Requires a validated principal; 403 without one.

Request

2 fields.

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

Response

StatusBodyMeaning
200domainView[]ok

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 list <project> <app>

Platform API · All Hanzo APIs · Interactive reference

How is this guide?

On this page