Search the docs

Search guides, API endpoints and MCP tools.

Catalog

list_environments

Read grantRead-onlyIdempotent

List the workspace's environments, sorted by name. Returns environments, each with the deployments of products that are not archived. Archived environments are left out unless archived says otherwise. Needs read access.

Inputs

archivedstring

Which environments to list: exclude (the default) leaves archived ones out, include adds them, only lists just them.

One ofexcludeincludeonly
tools/callJSON-RPC
{  "jsonrpc": "2.0",  "id": 1,  "method": "tools/call",  "params": {    "name": "list_environments",    "arguments": {      "archived": "exclude"    }  }}
POST/agent/v1/environments:list
curl -X POST https://api.qa.clankership.net/agent/v1/environments:list \  -H "Authorization: Bearer $CLANKER_AGENT_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "archived": "exclude"  }'
The same call over the agent HTTP API. Set CLANKER_AGENT_TOKEN to an agent OAuth access token.