OpenapiPlatform
List cd
Answers ONE app's reconciliation alone — the poll a deploy console makes while it waits, without re-reading the whole inventory each time.
GET /v1/platform/apps/{app}/cd
| Address | https://api.hanzo.ai/v1/platform/apps/{app}/cd |
| Method | GET |
| Operation | get_platform_apps_by_app_cd |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Answers ONE app's reconciliation alone — the poll a deploy console makes while it waits, without re-reading the whole inventory each time.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
app | path | string | yes | App is the DNS-1123 label of the declaration. |
org | query | string | — | Org names the organisation the declaration lives in, defaulting to the caller's own and subject to the same SuperAdmin rule as the listing. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | CDApp | ok |
200 body — 13 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
automated | body | boolean | — | Automated is whether CD applies git without being asked. |
health | body | string | — | Health is the workload's verdict: Healthy, Progressing, Degraded, Missing. |
message | body | string | — | Message is why, when Health is not Healthy. |
name | body | string | — | Name is the Application name the generator mints: <namespace>-<app>. |
namespace | body | string | — | Namespace is the DESTINATION namespace as the CR declares it — where the workload lands. |
operationMessage | body | string | — | |
path | body | string | — | Path is the values file CD renders against, relative to the chart source. |
phase | body | string | — | Phase is the last sync operation's phase (Running, Succeeded, Failed) and OperationMessage is its message. |
project | body | string | — | Project is the AppProject fence the sync is admitted under. |
reconciledAt | body | string | — | ReconciledAt is when CD last compared this Application. |
revision | body | string | — | Revision is the universe commit CD last applied. |
selfHeal | body | boolean | — | SelfHeal is whether CD also corrects drift the cluster introduced. |
sync | body | string | — | Sync is CD's verdict on git-versus-cluster: Synced, OutOfSync, or Unknown. |
Failure carries the platform error shape — see Errors.
Examples
hanzo platform apps cd <app>import { Configuration, PlatformApi } from 'hanzoai';
const api = new PlatformApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPlatformAppsByAppCd({ app: 'app' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PlatformApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PlatformApi(client).get_platform_apps_by_app_cd(app='app')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.PlatformAPI.GetPlatformAppsByAppCd(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, platform_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = platform_api::get_platform_apps_by_app_cd(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PlatformApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new PlatformApi(client).getPlatformAppsByAppCd();curl https://api.hanzo.ai/v1/platform/apps/<app>/cd \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches platform through the platform tool, which names its 39 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_builds"
}
}
}'How is this guide?