Skip to main content
GET
List environments

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org
string
required

Query Parameters

page
integer | null

Page number

Required range: 1 <= x <= 1000000
per_page
integer | null

Number of environments per page

Required range: 1 <= x <= 50
sort
enum<string>
default:name

Sort field

Available options:
name,
last_modified_at,
last_changed_at
sort_direction
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
space_id
string[] | null

Filter by space ID. Can be repeated for OR semantics, e.g. space_id=a&space_id=b

name
string | null

Filter by name (case-insensitive substring match)

type
enum<string>[] | null

Filter by environment type. Can be repeated, e.g. type=K8S&type=ECS

Available options:
K8S,
ECS,
S3,
lambda,
server,
docker,
azure-apps,
cloud-run,
logical
tag
string[] | null

Filter by tag key or key:value. Can be repeated, e.g. tag=team or tag=team:platform

archived
boolean
default:false

Return archived environments instead of live ones. An archived environment is listed under the name it was given when archived, '-archived-at-'.

policy
string | null

Only the environments the named environment policy is applied to. A name no policy has matches no environment.

Response

200 - application/json

Successful Response

page
integer
required

Number of this page, counting from 1

per_page
integer
required

Maximum number of items on a page

total_pages
integer
required

Number of pages the full result fills

total_count
integer
required

Number of items across all pages

environments
GetEnvironmentResponse · object[]
required

Links to related resources, keyed by relation (self, next, ...), each a link or a list of links