Skip to main content
GET
List environments

Authorizations

X-Api-Key
string
header
required

Query Parameters

organizationId
string<uuid>

The organisation whose environments to list. The caller must belong to it. Defaults to the one organization the caller acts in, such as an API key's. Required when the caller belongs to several.

agentId
string<uuid>

Only environments bound to this agent. Omit for every standalone environment in the organisation, the agentless ones included.

lifecycle
enum<string>

Which lifecycle states to return. Omit for running environments only. Which lifecycle states a list should return. A coarser handle than the status enum, and the one a caller actually wants: what is still usable, what is finished, or everything.

Available options:
running,
terminal,
all

Response

The request has succeeded.

Response for the list endpoint, ordered by createdAt DESC. Empty array when nothing matches the filters.

environments
object[]
required

The matching environments.