# List environments

URL: https://docs.hanzo.ai/docs/openapi/platform/get-platform-environments

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

`GET /v1/platform/environments`

> [Platform →](https://docs.hanzo.ai/docs/openapi/platform) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

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

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

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; 401 without one.

## Request

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

## Response

| Status    | Body                      | Meaning |
| --------- | ------------------------- | ------- |
| `200`     | platform.environmentBoard | ok      |
| `default` | problem-details           | refused |

`200` body — 7 fields.

| Field                      | In   | Type                       | Always | Description                                                                                                                                    |
| -------------------------- | ---- | -------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `environments`             | body | platform.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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo platform environments
```

**SDK**

**.ts**

```ts
import { Configuration, PlatformApi } from 'hanzoai';

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

**.py**

```python
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()
```

**.go**

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

resp, _, err := client.PlatformAPI.GetPlatformEnvironments(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::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?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PlatformApi;

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

var result = new PlatformApi(client).getPlatformEnvironments();
```

**HTTP**

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

**MCP**

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

```bash
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_build"
         }
       }
     }'
```

---

[Platform API](https://docs.hanzo.ai/docs/openapi/platform) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)