Skip to main content
GET
List environments

Authorizations

X-Asteroid-Agents-Api-Key
string
header
required

Query Parameters

agentId
string<uuid>
required

The agent whose environments to list. Gates access, and supplies the organisation.

includeTerminal
boolean

Include stopped, failed and dead environments. Omit for running environments only.

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.