OpenapiPlatform
Get apps
Answers ONE declaration — what git says this app is, before the delivery plane has had any say in it.
GET /v1/platform/apps/{app}
| Address | https://api.hanzo.ai/v1/platform/apps/{app} |
| Method | GET |
| Operation | get_platform_apps_by_app |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Answers ONE declaration — what git says this app is, before the delivery plane has had any say in it.
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 | Declaration | ok |
200 body — 15 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
application | body | string | — | Application is the CD Application name the generator mints: <org>-<name>. |
automated | body | boolean | — | Automated is cd.automated: false means the Application reports drift and NOTHING moves. |
digest | body | string | — | image.digest — wins over tag |
env | body | declareEnv[] | — | Env is the declared container environment, as the chart's list of {name,value}. |
env[].name | body | string | — | |
env[].public | body | boolean | — | Public marks a value that may be WRITTEN INTO GIT. Absent, it is false, and the value is sealed into KMS and referenced. |
env[].value | body | string | — | |
hosts | body | string[] | — | ingress.hosts, both shapes flattened |
name | body | string | — | the Helm release name — the file's basename |
org | body | string | — | Org is the owner. |
path | body | string | — | Path is the file, relative to the repository root. |
project | body | string | — | Project is the AppProject the sync is admitted under, derived from the directory exactly as the ApplicationSet derives it. |
replicas | body | integer | — | |
repository | body | string | — | image.repository |
tag | body | string | — | image.tag |
Failure carries the platform error shape — see Errors.
Examples
hanzo platform apps get <app>import { Configuration, PlatformApi } from 'hanzoai';
const api = new PlatformApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPlatformAppsByApp({ 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(app='app')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.PlatformAPI.GetPlatformAppsByApp(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(&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).getPlatformAppsByApp();curl https://api.hanzo.ai/v1/platform/apps/<app> \
-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?