Hanzo AI
OpenapiPlatform

List apps

Answers what this organisation has declared, joined with what the delivery plane has done about it.

GET /v1/platform/apps

Addresshttps://api.hanzo.ai/v1/platform/apps
MethodGET
Operationget_platform_apps
AuthAuthorization: Bearer $HANZO_API_KEY

Answers what this organisation has declared, joined with what the delivery plane has done about it.

The join is best-effort BY DESIGN and says so when it is missing: the declarations ARE the answer to "what have I deployed", so refusing the whole board because the cluster is unreadable would lose the half that is readable. What must never happen is a silent null — an unreadable plane is reported as cd.unavailable carrying the reason, never as an app with no reconciliation.

Request

1 field.

FieldInTypeRequiredDescription
orgquerystringOrg names the organisation whose declarations to read, defaulting to the caller's own.

Response

StatusBodyMeaning
200declaredRespok

200 body — 33 fields.

FieldInTypeAlwaysDescription
appsbodydeclared[]
apps[].applicationbodystring
apps[].automatedbodyboolean
apps[].cdbodyCDApp
apps[].cd.automatedbodybooleanAutomated is whether CD applies git without being asked.
apps[].cd.healthbodystringHealth is the workload's verdict: Healthy, Progressing, Degraded, Missing.
apps[].cd.messagebodystringMessage is why, when Health is not Healthy.
apps[].cd.namebodystringName is the Application name the generator mints: <namespace>-<app>.
apps[].cd.namespacebodystringNamespace is the DESTINATION namespace as the CR declares it — where the workload lands.
apps[].cd.operationMessagebodystring
apps[].cd.pathbodystringPath is the values file CD renders against, relative to the chart source.
apps[].cd.phasebodystringPhase is the last sync operation's phase (Running, Succeeded, Failed) and OperationMessage is its message.
apps[].cd.projectbodystringProject is the AppProject fence the sync is admitted under.
apps[].cd.reconciledAtbodystringReconciledAt is when CD last compared this Application.
apps[].cd.revisionbodystringRevision is the universe commit CD last applied.
apps[].cd.selfHealbodybooleanSelfHeal is whether CD also corrects drift the cluster introduced.
apps[].cd.syncbodystringSync is CD's verdict on git-versus-cluster: Synced, OutOfSync, or Unknown.
apps[].digestbodystring
apps[].envbodydeclareEnv[]
apps[].env[].namebodystring
apps[].env[].publicbodybooleanPublic marks a value that may be WRITTEN INTO GIT. Absent, it is false, and the value is sealed into KMS and referenced.
apps[].env[].valuebodystring
apps[].hostsbodystring[]
apps[].namebodystring
apps[].orgbodystring
apps[].pathbodystring
apps[].projectbodystring
apps[].replicasbodyinteger
apps[].repositorybodystring
apps[].tagbodystring
cdUnavailablebodyunreadable
cdUnavailable.reasonbodystring
orgbodystringOrg is the directory read — the caller's own, or another when a SuperAdmin asked to act as it.

Failure carries the platform error shape — see Errors.

Examples

hanzo platform apps list

Platform API · All Hanzo APIs · Interactive reference

How is this guide?

On this page