Returns your deploy targets, and what is running on each.

GET /v1/platform/environments

Platform → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/platform/environments`
Method	`GET`
Operation	`get_platform_environments`
Auth	`Authorization: Bearer $HANZO_API_KEY`

It returns the org's environments — the distinct deploy targets its applications name, production for anything that names none — each aggregating the apps that target it, a rolled-up status and when it last changed.

An environment is DERIVED, not stored: there is nothing to create or delete here, and an environment exists exactly as long as an app points at it. Requires a validated principal; 403 without one.

Request

GET /v1/platform/environments takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	environmentBoard	ok

200 body — 7 fields.

Field	In	Type	Always	Description
`environments`	body	environmentRow[]	—	Environments are the org's deploy targets, in first-seen order.
`environments[].id`	body	string	—	ID is the environment's name, which is also its identity — an environment is derived from the apps that target it, so it has no id of its own.
`environments[].name`	body	string	—	Name is the environment's name as an app declared it.
`environments[].services`	body	string[]	—	Services are the apps that target this environment, by name.
`environments[].status`	body	string	—	Status rolls up the real states of this environment's apps: degraded, active, idle or empty.
`environments[].type`	body	string	—	Type buckets the name for display: production, staging, development or custom.
`environments[].updatedAt`	body	string	—	UpdatedAt is when any of them last changed, RFC3339 UTC; empty when unset.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, PlatformApi } from 'hanzoai';

const api = new PlatformApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPlatformEnvironments();

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_environments()

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

resp, _, err := client.PlatformAPI.GetPlatformEnvironments(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_environments(&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).getPlatformEnvironments();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/platform/environments \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches platform through the platform tool, which names its 39 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": "list_builds"
         }
       }
     }'

Platform API · All Hanzo APIs · Interactive reference

Returns your deploy targets, and what is running on each.

Request

Response

Examples

On this page