ApplicationService

Watch returns stream of application resource tree

GET
https://argocd.example.com/api/v1/stream/applications/{applicationName}/resource-tree

Parameters

applicationNamestringrequiredpath
namespacestringquery
namestringquery
versionstringquery
groupstringquery
kindstringquery
appNamespacestringquery
projectstringquery

Response

200OKobject

A successful response.(streaming responses)

Response fields application/json
errorruntimeStreamError
Show child attributes
detailsArray<protobufAny>
Show child attributes
type_urlstring
valuestring<byte>
grpc_codeinteger<int32>
http_codeinteger<int32>
http_statusstring
messagestring
resultv1alpha1ApplicationTree

ApplicationTree represents the hierarchical structure of resources associated with an Argo CD application.

Show child attributes
hostsArray<v1alpha1HostInfo>

Hosts provides a list of Kubernetes nodes that are running pods related to the application.

Show child attributes

HostInfo holds metadata and resource usage metrics for a specific host in the cluster.

labelsobject

Labels holds the labels attached to the host.

Show child attributes
[key: string]string
namestring

Name is the hostname or node name in the Kubernetes cluster.

resourcesInfoArray<v1alpha1HostResourceInfo>

ResourcesInfo provides a list of resource usage details for different resource types on this host.

Show child attributes

HostResourceInfo represents resource usage details for a specific resource type on a host.

capacityinteger<int64>

Capacity represents the total available capacity of this resource on the host.

requestedByAppinteger<int64>

RequestedByApp indicates the total amount of this resource requested by the application running on the host.

requestedByNeighborsinteger<int64>

RequestedByNeighbors indicates the total amount of this resource requested by other workloads on the same host.

resourceNamestring

ResourceName specifies the type of resource (e.g., CPU, memory, storage).

systemInfov1NodeSystemInfo

NodeSystemInfo is a set of ids/uuids to uniquely identify the node.

Show child attributes
architecturestring
bootIDstring

Boot ID reported by the node.

containerRuntimeVersionstring

ContainerRuntime Version reported by the node through runtime remote API (e.g. containerd://1.4.2).

kernelVersionstring

Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64).

kubeProxyVersionstring

Deprecated: KubeProxy Version reported by the node.

kubeletVersionstring

Kubelet Version reported by the node.

machineIDstring
operatingSystemstring
osImagestring

OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)).

runningInUserNamespaceboolean
swapv1NodeSwapStatus

NodeSwapStatus represents swap memory information.

Show child attributes
capacityinteger<int64>
systemUUIDstring
nodesArray<v1alpha1ResourceNode>

Nodes contains a list of resources that are either directly managed by the application or are children of directly managed resources.

Show child attributes

ResourceNode contains information about a live Kubernetes resource and its relationships with other resources.

createdAtv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

healthv1alpha1HealthStatus
Show child attributes
lastTransitionTimev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring
statusstring
imagesArray<string>

Images lists container images associated with the resource. This is primarily useful for pods and other workload resources.

infoArray<v1alpha1InfoItem>

Info provides additional metadata or annotations about the resource.

Show child attributes
namestring

Name is a human readable title for this piece of information.

valuestring

Value is human readable content.

networkingInfov1alpha1ResourceNetworkingInfo

ResourceNetworkingInfo holds networking-related information for a resource.

Show child attributes
externalURLsArray<string>

ExternalURLs holds a list of URLs that should be accessible externally. This field is typically populated for Ingress resources based on their hostname rules.

ingressArray<v1LoadBalancerIngress>

Ingress provides information about external access points (e.g., load balancer ingress) for this resource.

Show child attributes

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

hostnamestring
ipstring
ipModestring
portsArray<v1PortStatus>
Show child attributes
errorstring
portinteger<int32>
protocolstring
labelsobject

Labels holds the labels associated with this networking resource.

Show child attributes
[key: string]string
targetLabelsobject

TargetLabels represents labels associated with the target resources that this resource communicates with.

Show child attributes
[key: string]string
targetRefsArray<v1alpha1ResourceRef>

TargetRefs contains references to other resources that this resource interacts with, such as Services or Pods.

Show child attributes
groupstring
kindstring
namestring
namespacestring
uidstring
versionstring
parentRefsArray<v1alpha1ResourceRef>

ParentRefs lists the parent resources that reference this resource. This helps in understanding ownership and hierarchical relationships.

Show child attributes
groupstring
kindstring
namestring
namespacestring
uidstring
versionstring
resourceVersionstring

ResourceVersion indicates the version of the resource, used to track changes.

groupstring
kindstring
namestring
namespacestring
uidstring
versionstring
orphanedNodesArray<v1alpha1ResourceNode>

OrphanedNodes contains resources that exist in the same namespace as the application but are not managed by it. This list is populated only if orphaned resource tracking is enabled in the application's project settings.

Show child attributes

ResourceNode contains information about a live Kubernetes resource and its relationships with other resources.

createdAtv1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

healthv1alpha1HealthStatus
Show child attributes
lastTransitionTimev1Time<date-time>

Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.

+protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false

messagestring
statusstring
imagesArray<string>

Images lists container images associated with the resource. This is primarily useful for pods and other workload resources.

infoArray<v1alpha1InfoItem>

Info provides additional metadata or annotations about the resource.

Show child attributes
namestring

Name is a human readable title for this piece of information.

valuestring

Value is human readable content.

networkingInfov1alpha1ResourceNetworkingInfo

ResourceNetworkingInfo holds networking-related information for a resource.

Show child attributes
externalURLsArray<string>

ExternalURLs holds a list of URLs that should be accessible externally. This field is typically populated for Ingress resources based on their hostname rules.

ingressArray<v1LoadBalancerIngress>

Ingress provides information about external access points (e.g., load balancer ingress) for this resource.

Show child attributes

LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point.

hostnamestring
ipstring
ipModestring
portsArray<v1PortStatus>
Show child attributes
errorstring
portinteger<int32>
protocolstring
labelsobject

Labels holds the labels associated with this networking resource.

Show child attributes
[key: string]string
targetLabelsobject

TargetLabels represents labels associated with the target resources that this resource communicates with.

Show child attributes
[key: string]string
targetRefsArray<v1alpha1ResourceRef>

TargetRefs contains references to other resources that this resource interacts with, such as Services or Pods.

Show child attributes
groupstring
kindstring
namestring
namespacestring
uidstring
versionstring
parentRefsArray<v1alpha1ResourceRef>

ParentRefs lists the parent resources that reference this resource. This helps in understanding ownership and hierarchical relationships.

Show child attributes
groupstring
kindstring
namestring
namespacestring
uidstring
versionstring
resourceVersionstring

ResourceVersion indicates the version of the resource, used to track changes.

groupstring
kindstring
namestring
namespacestring
uidstring
versionstring
shardsCountinteger<int64>

ShardsCount represents the total number of shards the application tree is split into. This is used to distribute resource processing across multiple shards.

defaultruntimeError

An unexpected error response.

Response fields application/json
codeinteger<int32>
detailsArray<protobufAny>
Show child attributes
type_urlstring
valuestring<byte>
errorstring
messagestring

Authorization

bearerapiKey in header

A token sent as Authorization: Bearer <token>. API Docs shows how to get one.

Docs by Sourcey
↑↓ navigate↵ selectesc close