Hanzo
OpenapiDeploy

Returns the fleet as an argocd ApplicationList: one projected Application per…

Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually…

GET /v1/deploy/applications

Addresshttps://api.hanzo.ai/v1/deploy/applications
MethodGET
Operationget_deploy_applications
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the fleet as an argocd ApplicationList: one projected Application per operator App CR, carrying the image tag the CR DECLARES, the tag actually RUNNING in the cluster's Deployment, the reconciled health, and the sync verdict those two produce (declared == running ⇒ Synced, both known and different ⇒ OutOfSync, either unknown ⇒ Unknown).

It is TENANT-SCOPED: a platform SuperAdmin reads every platform namespace, a validated org member reads only its own org's tenant namespace and only the App CRs labelled with its org, and anyone else is refused. A cross-tenant CR is never projected into an answer.

Request

GET /v1/deploy/applications takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200argoAppListok

200 body — 44 fields.

FieldInTypeAlwaysDescription
apiVersionbodystringAPIVersion is the constant "argoproj.io/v1alpha1".
itemsbodyargoApp[]Items is one entry per operator App CR the caller may see — its own org's, or every platform namespace's for a SuperAdmin — followed, for a SuperAdmin only, by…
items[].apiVersionbodystringAPIVersion is the constant "argoproj.io/v1alpha1" — the shape, not the source.
items[].kindbodystringKind is the constant "Application".
items[].metadatabodyargoMeta
items[].metadata.creationTimestampbodystringCreationTimestamp is when the source object was created, RFC 3339 to the second.
items[].metadata.labelsbodyobjectLabels are the labels this projection puts on the row, not the source object's full label set.
items[].metadata.labels.*bodystring
items[].metadata.namebodystringName is the projected object's name: the App CR's metadata.name for an application, the CD Application's name for a CD row, and the IAM project name for a…
items[].metadata.namespacebodystringNamespace is the namespace the source object was read from — the tenant or platform namespace for an App CR, CD's controller namespace for a CD row.
items[].metadata.uidbodystringUID is the k8s metadata.uid of the source object, which is what the SPA keys a row on across refreshes.
items[].specbodyargoSpec
items[].spec.destinationbodyargoDestination
items[].spec.destination.namebodystringArgoCD allows a destination by cluster name; omitted for the in-cluster projection.
items[].spec.destination.namespacebodystringNamespace is where in that cluster the workload lands.
items[].spec.destination.serverbodystringServer is the cluster API URL the application reconciles into.
items[].spec.projectbodystringProject is the AppProject this application is grouped and filtered under.
items[].spec.sourcebodyargoSource
items[].spec.source.pathbodystringPath is the directory within RepoURL.
items[].spec.source.repoURLbodystringRepoURL is the git repository the desired state comes from.
items[].spec.source.targetRevisionbodystringTargetRevision is the git ref tracked there — a branch such as "main".
items[].statusbodyargoStatus
items[].status.healthbodyargoHealth
items[].status.health.messagebodystringMessage is why the status is what it is — "Running: no replicas ready", "iam: CrashLoopBackOff".
items[].status.health.statusbodystringStatus is the ArgoCD health vocabulary, Capitalized: Healthy, Progressing, Degraded, Suspended, Missing or Unknown.
items[].status.reconciledAtbodystringReconciledAt is when the desired state was last compared against the cluster, RFC 3339.
items[].status.resourcesbodyargoResourceStatus[]Resources are the objects the application owns.
items[].status.resources[].groupbodystringGroup is the object's API group: empty for the core group (Pod, Service, ConfigMap), otherwise apps, networking.k8s.io, autoscaling or policy — and hanzo.ai…
items[].status.resources[].healthbodyargoHealth
items[].status.resources[].health.messagebodystringMessage is why the status is what it is — "Running: no replicas ready", "iam: CrashLoopBackOff".
items[].status.resources[].health.statusbodystringStatus is the ArgoCD health vocabulary, Capitalized: Healthy, Progressing, Degraded, Suspended, Missing or Unknown.
items[].status.resources[].kindbodystringKind is the object kind — App, Deployment, ReplicaSet, Pod, Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget, ConfigMap.
items[].status.resources[].namebodystringName is the object's metadata.name.
items[].status.resources[].namespacebodystringNamespace is the namespace the object was found in — the same one for every entry of an application, since the walk is confined to it.
items[].status.resources[].statusbodystringStatus is the APPLICATION's sync verdict repeated on every row, not a per-object one.
items[].status.resources[].versionbodystringVersion is the object's API version as the live object reports it: v1 for every kind here except the HorizontalPodAutoscaler, which is autoscaling/v2.
items[].status.summarybodyargoSummary
items[].status.summary.imagesbodystring[]Images are the container images the application runs.
items[].status.syncbodyargoSyncStatus
items[].status.sync.revisionbodystringRevision is what Status was reached against. For an App CR that is the declared IMAGE TAG, not a commit — the CR is image-pinned.
items[].status.sync.statusbodystringStatus is the ArgoCD sync vocabulary, Capitalized: Synced, OutOfSync or Unknown.
kindbodystringKind is the constant "ApplicationList".
metadatabodyargoListMeta
metadata.resourceVersionbodystringResourceVersion is the k8s list version a watch would resume from.

Failure carries the platform error shape — see Errors.

Examples

hanzo deploy applications list

Deploy API · All Hanzo APIs · Interactive reference

How is this guide?

On this page