GET /v1/environments/{environment_id}
Returns the full details of a single environment by ID.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
environment_id | string | Yes | Environment unique identifier (with the env_ prefix) |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
id | string | Environment unique identifier with the env_ prefix |
type | string | Always "environment" |
name | string | Environment name |
description | string | Environment description |
status | string | Environment status ("ready" or "archived") |
config | Environment config | Environment configuration |
metadata | Metadata object | Custom metadata |
archived | boolean | Whether archived (default false) |
archived_at | string|null | Archive time (ISO 8601), null when not archived |
created_at | string | Creation time (ISO 8601) |
updated_at | string | Last update time (ISO 8601) |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT invalid or expired |
| 403 | permission_error | Not authorized for this resource |
| 404 | not_found_error | Environment with the given ID does not exist |
Related
Cloud environment setup
Choose the container, network, and dependencies your agent runs in.