Hanzo
OpenapiDeploy

Returns one application's argocd ApplicationTree: the objects the operator…

Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it,…

GET /v1/deploy/applications/{name}/resource-tree

Addresshttps://api.hanzo.ai/v1/deploy/applications/{name}/resource-tree
MethodGET
Operationget_deploy_applications_by_name_resource-tree
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one application's argocd ApplicationTree: the objects the operator reconciled from its App CR, reached by ownerRef — the Deployment and, under it, the ReplicaSet and Pods, plus the Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and ConfigMaps it owns — each node carrying its parent edges and its health.

Secrets are DELIBERATELY not walked, so no materialized environment can ever appear in the tree. Tenant-scoped exactly like the application read: another org's name is not found, a malformed name is a 400.

Request

1 field.

FieldInTypeRequiredDescription
namepathstringyesName is the application to read, from the path.

Response

StatusBodyMeaning
200argoTreeok

200 body — 47 fields.

FieldInTypeAlwaysDescription
hostsbodyobject[]Hosts is ArgoCD's per-node machine inventory.
nodesbodyargoNode[]Nodes is the FLAT node list, root first: the App CR, then the objects the operator owns, then their ReplicaSets and Pods.
nodes[].createdAtbodystringCreatedAt is the object's creationTimestamp, RFC 3339 UTC to the second.
nodes[].groupbodystring
nodes[].healthbodyargoHealth
nodes[].health.messagebodystringMessage is why the status is what it is — "Running: no replicas ready", "iam: CrashLoopBackOff".
nodes[].health.statusbodystringStatus is the ArgoCD health vocabulary, Capitalized: Healthy, Progressing, Degraded, Suspended, Missing or Unknown.
nodes[].imagesbodystring[]Images are the container images running on this node.
nodes[].infobodyargoInfoItem[]Info are the chips shown on the node. At most one: the image tag — the RUNNING tag on a Deployment, ReplicaSet or Pod, and the DECLARED tag on the App CR at…
nodes[].info[].namebodystringName is the chip's label.
nodes[].info[].valuebodystringValue is the chip's value — for "Image Tag", the tag the node runs.
nodes[].kindbodystring
nodes[].namebodystring
nodes[].namespacebodystring
nodes[].parentRefsbodyargoResourceRef[]ParentRefs are the node's edges UPWARD, which is how the SPA draws the DAG from this flat list.
nodes[].parentRefs[].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…
nodes[].parentRefs[].kindbodystringKind is the object kind. The root is the App CR; below it come Deployment, ReplicaSet, Pod, Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and…
nodes[].parentRefs[].namebodystringName is the object's metadata.name.
nodes[].parentRefs[].namespacebodystringNamespace is the namespace the walk ran in, the same for every node of one tree.
nodes[].parentRefs[].uidbodystringUID is the object's metadata.uid.
nodes[].parentRefs[].versionbodystringVersion is the object's API version as the live object reports it: v1 for every kind the walk reaches except the HorizontalPodAutoscaler, which is…
nodes[].resourceVersionbodystringResourceVersion is the k8s version a watch would resume from.
nodes[].uidbodystring
nodes[].versionbodystring
orphanedNodesbodyargoNode[]OrphanedNodes are objects in the namespace belonging to no application.
orphanedNodes[].createdAtbodystringCreatedAt is the object's creationTimestamp, RFC 3339 UTC to the second.
orphanedNodes[].groupbodystring
orphanedNodes[].healthbodyargoHealth
orphanedNodes[].health.messagebodystringMessage is why the status is what it is — "Running: no replicas ready", "iam: CrashLoopBackOff".
orphanedNodes[].health.statusbodystringStatus is the ArgoCD health vocabulary, Capitalized: Healthy, Progressing, Degraded, Suspended, Missing or Unknown.
orphanedNodes[].imagesbodystring[]Images are the container images running on this node.
orphanedNodes[].infobodyargoInfoItem[]Info are the chips shown on the node. At most one: the image tag — the RUNNING tag on a Deployment, ReplicaSet or Pod, and the DECLARED tag on the App CR at…
orphanedNodes[].info[].namebodystringName is the chip's label.
orphanedNodes[].info[].valuebodystringValue is the chip's value — for "Image Tag", the tag the node runs.
orphanedNodes[].kindbodystring
orphanedNodes[].namebodystring
orphanedNodes[].namespacebodystring
orphanedNodes[].parentRefsbodyargoResourceRef[]ParentRefs are the node's edges UPWARD, which is how the SPA draws the DAG from this flat list.
orphanedNodes[].parentRefs[].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…
orphanedNodes[].parentRefs[].kindbodystringKind is the object kind. The root is the App CR; below it come Deployment, ReplicaSet, Pod, Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget and…
orphanedNodes[].parentRefs[].namebodystringName is the object's metadata.name.
orphanedNodes[].parentRefs[].namespacebodystringNamespace is the namespace the walk ran in, the same for every node of one tree.
orphanedNodes[].parentRefs[].uidbodystringUID is the object's metadata.uid.
orphanedNodes[].parentRefs[].versionbodystringVersion is the object's API version as the live object reports it: v1 for every kind the walk reaches except the HorizontalPodAutoscaler, which is…
orphanedNodes[].resourceVersionbodystringResourceVersion is the k8s version a watch would resume from.
orphanedNodes[].uidbodystring
orphanedNodes[].versionbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo deploy applications resource-tree <name>

Deploy API · All Hanzo APIs · Interactive reference

How is this guide?

On this page