On this page
environments.list
List this organization's production and sandbox environments
Request
GET /api/v1/environments
- MCP:
environments_list - SDK:
client.environments.list(SDK path arguments usepath; MCP usesparams). - Minimum API key role: viewer.
- Idempotency: none.
current names the key's environment. Each item's tenant_id is what agents_import reference.tenant_id needs; the slug and tenant_id identify the environment when asking Cumulus staff for capacity or admission.
Input schema
json
{
"parameters": [],
"requestBody": null
}
Responses
json
{
"200": {
"description": "List this organization's production and sandbox environments",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnvironmentsListResponse200"
}
}
}
},
"4XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
},
"5XX": {
"description": "Typed error (ApiError)",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError"
}
}
}
}
}
Referenced schemas
json
{
"components": {
"schemas": {
"EnvironmentsListResponse200": {
"type": "object",
"properties": {
"current": {
"type": "string",
"enum": [
"production",
"sandbox"
]
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"production",
"sandbox"
]
},
"tenant_id": {
"type": "string",
"format": "uuid"
},
"slug": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1
},
"display_name": {
"type": "string",
"nullable": true
}
},
"required": [
"kind",
"tenant_id",
"slug",
"name",
"display_name"
],
"additionalProperties": false
}
}
},
"required": [
"current",
"items"
],
"additionalProperties": false
},
"ApiError": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string",
"enum": [
"unauthenticated",
"forbidden",
"not_found",
"conflict",
"invalid_request",
"idempotency_conflict",
"policy_denied",
"capability_unavailable",
"provider_unavailable",
"knowledge_unavailable",
"publication_invalid",
"run_not_active",
"rate_limited",
"outcome_unknown",
"internal"
]
},
"message": {
"type": "string"
},
"retryable": {
"type": "boolean"
},
"outcome": {
"type": "string",
"enum": [
"none",
"unknown"
]
},
"details": {
"type": "object",
"additionalProperties": {}
}
},
"required": [
"code",
"message",
"retryable",
"outcome"
],
"additionalProperties": false
}
},
"required": [
"error"
],
"additionalProperties": false
}
}
}
}
Errors and recovery
See API error handling and Troubleshooting.
Related guides
Content version 381951f7Markdown source