Returns the argocd AuthSettings object the dashboard SPA awaits before its…
Returns the argocd AuthSettings object the dashboard SPA awaits before its first render.
GET /v1/deploy/settings
| Address | https://api.hanzo.ai/v1/deploy/settings |
| Method | GET |
| Operation | get_deploy_settings |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns the argocd AuthSettings object the dashboard SPA awaits before its first render.
Every value is a CONSTANT of this projection rather than configuration read from anywhere: the SPA's own login form is reported disabled and its OIDC config null because Hanzo IAM owns identity at the edge and this console's sign-in is GET /v1/deploy/login, and every argocd feature the projection does not implement — status badges, Dex connectors, config-management plugins, kustomize versions, the exec terminal, apps-in-any-namespace, the hydrator, sync-with-replace — is reported off. Platform SuperAdmin only.
Request
GET /v1/deploy/settings takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | consoleSettings | ok |
200 body — 23 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
appsInAnyNamespaceEnabled | body | boolean | — | AppsInAnyNamespaceEnabled is false: applications are projected from operator App CRs in the platform namespaces, never declared in an arbitrary one. |
dexConfig | body | object | — | DexConfig carries no connectors. |
dexConfig.connectors | body | deployEmpty[] | — | |
execEnabled | body | boolean | — | ExecEnabled is false: this plane serves no container terminal. |
googleAnalytics | body | object | — | GoogleAnalytics carries no tracking id and anonymizes users — this console reports no analytics. |
googleAnalytics.anonymizeUsers | body | boolean | — | |
googleAnalytics.trackingID | body | string | — | |
help | body | object | — | Help carries no chat link and no binary download URLs. |
help.binaryUrls | body | object | — | |
help.binaryUrls.* | body | string | — | |
help.chatText | body | string | — | |
help.chatUrl | body | string | — | |
hydratorEnabled | body | boolean | — | HydratorEnabled is false: there is no manifest hydrator on this plane. |
kustomizeVersions | body | string[] | — | KustomizeVersions is always empty: an App CR is an image pin, not a kustomize build. |
oidcConfig | body | deployEmpty | — | |
plugins | body | deployEmpty[] | — | Plugins is always empty: this plane loads no argocd config-management plugins. |
statusBadgeEnabled | body | boolean | — | StatusBadgeEnabled is false: no badge endpoint is served. |
statusBadgeRootUrl | body | string | — | StatusBadgeRootUrl is always empty, for the same reason. |
syncWithReplaceAllowed | body | boolean | — | SyncWithReplaceAllowed is false: a sync here asks the operator to reconcile an App CR, and never replaces an object. |
uiBannerContent | body | string | — | UiBannerContent is always empty: this console shows no banner. |
uiCssURL | body | string | — | UiCssURL is always empty: no stylesheet is injected. |
url | body | string | — | Url is the console's public origin, https://cd.hanzo.ai. |
userLoginsDisabled | body | boolean | — | UserLoginsDisabled is true: the SPA must not render its own username/password form. |
Failure carries the platform error shape — see Errors.
Examples
hanzo deploy settingsimport { Configuration, DeployApi } from 'hanzoai';
const api = new DeployApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDeploySettings();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_settings()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.DeployAPI.GetDeploySettings(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::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_settings(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DeployApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new DeployApi(client).getDeploySettings();curl https://api.hanzo.ai/v1/deploy/settings \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches deploy through the deploy tool, which names its 21 operations with its own verbs — this one among them, under a name only the door 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": "get_deploy_account_can_i"
}
}
}'How is this guide?