Get applications

Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail view rather than a row of the list.

GET /v1/deploy/applications/{name}

Deploy → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/deploy/applications/{name}`
Method	`GET`
Operation	`get_deploy_applications_by_name`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns ONE projected argocd Application by name, with status.resources filled in from its reconciled resource tree — which is what makes it the detail view rather than a row of the list.

It is TENANT-SCOPED, and a name that belongs to another org is reported NOT FOUND rather than refused: a 403 would confirm the application exists, so the route would become a cross-tenant existence oracle. A name that is not a DNS-1123 label is a 400 before any cluster read.

Request

1 field.

Field	In	Type	Required	Description
`name`	path	string	yes	Name is the application to read, from the path.

Response

Status	Body	Meaning
`200`	deploy.argoApp	ok
`default`	problem-details	refused

200 body — 39 fields.

Field	In	Type	Always	Description
`apiVersion`	body	string	—	APIVersion is the constant "argoproj.io/v1alpha1" — the shape, not the source.
`kind`	body	string	—	Kind is the constant "Application".
`metadata`	body	deploy.argoMeta	—
`metadata.creationTimestamp`	body	string	—	CreationTimestamp is when the source object was created, RFC 3339 to the second.
`metadata.labels`	body	object	—	Labels are the labels this projection puts on the row, not the source object's full label set.
`metadata.labels.*`	body	string	—
`metadata.name`	body	string	—	Name 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 project.
`metadata.namespace`	body	string	—	Namespace 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.
`metadata.uid`	body	string	—	UID is the k8s metadata.uid of the source object, which is what the SPA keys a row on across refreshes.
`spec`	body	deploy.argoSpec	—
`spec.destination`	body	deploy.argoDestination	—
`spec.destination.name`	body	string	—	ArgoCD allows a destination by cluster name; omitted for the in-cluster projection.
`spec.destination.namespace`	body	string	—	Namespace is where in that cluster the workload lands.
`spec.destination.server`	body	string	—	Server is the cluster API URL the application reconciles into.
`spec.project`	body	string	—	Project is the AppProject this application is grouped and filtered under.
`spec.source`	body	deploy.argoSource	—
`spec.source.path`	body	string	—	Path is the directory within RepoURL.
`spec.source.repoURL`	body	string	—	RepoURL is the git repository the desired state comes from.
`spec.source.targetRevision`	body	string	—	TargetRevision is the git ref tracked there — a branch such as "main".
`status`	body	deploy.argoStatus	—
`status.health`	body	deploy.argoHealth	—
`status.health.message`	body	string	—	Message is why the status is what it is — "Running: no replicas ready", "iam: CrashLoopBackOff".
`status.health.status`	body	string	—	Status is the ArgoCD health vocabulary, Capitalized: Healthy, Progressing, Degraded, Suspended, Missing or Unknown.
`status.reconciledAt`	body	string	—	ReconciledAt is when the desired state was last compared against the cluster, RFC 3339.
`status.resources`	body	deploy.argoResourceStatus[]	—	Resources are the objects the application owns.
`status.resources[].group`	body	string	—	Group 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 for the App CR itself.
`status.resources[].health`	body	deploy.argoHealth	—
`status.resources[].health.message`	body	string	—	Message is why the status is what it is — "Running: no replicas ready", "iam: CrashLoopBackOff".
`status.resources[].health.status`	body	string	—	Status is the ArgoCD health vocabulary, Capitalized: Healthy, Progressing, Degraded, Suspended, Missing or Unknown.
`status.resources[].kind`	body	string	—	Kind is the object kind — App, Deployment, ReplicaSet, Pod, Service, Ingress, HorizontalPodAutoscaler, PodDisruptionBudget, ConfigMap.
`status.resources[].name`	body	string	—	Name is the object's metadata.name.
`status.resources[].namespace`	body	string	—	Namespace is the namespace the object was found in — the same one for every entry of an application, since the walk is confined to it.
`status.resources[].status`	body	string	—	Status is the APPLICATION's sync verdict repeated on every row, not a per-object one.
`status.resources[].version`	body	string	—	Version is the object's API version as the live object reports it: v1 for every kind here except the HorizontalPodAutoscaler, which is autoscaling/v2.
`status.summary`	body	deploy.argoSummary	—
`status.summary.images`	body	string[]	—	Images are the container images the application runs.
`status.sync`	body	deploy.argoSyncStatus	—
`status.sync.revision`	body	string	—	Revision is what Status was reached against.
`status.sync.status`	body	string	—	Status is the ArgoCD sync vocabulary, Capitalized: Synced, OutOfSync or Unknown.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo deploy applications get <name>

.ts

.py

.go

.rs

.java

import { Configuration, DeployApi } from 'hanzoai';

const api = new DeployApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDeployApplicationsByName({ name: 'name' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DeployApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DeployApi(client).get_deploy_applications_by_name(name='name')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.DeployAPI.GetDeployApplicationsByName(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, deploy_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = deploy_api::get_deploy_applications_by_name(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DeployApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new DeployApi(client).getDeployApplicationsByName();

curl https://api.hanzo.ai/v1/deploy/applications/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches deploy through the deploy tool, which names its 11 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_deploy_applications"
         }
       }
     }'

Deploy API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList syncwindows NextList applications — GET /v1/deploy/applications