v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Projects & Environments

List environments

List a particular project's environments matching the provided filters. If no filters are provided, all environments are returned.

get/environments

Query parameters

namestring[]

Filter by name

projectIdstring[] required

Filter for resources that belong to a project

createdBeforestring date-time

Filter for resources created before a certain time (specified as an ISO 8601 timestamp)

createdAfterstring date-time

Filter for resources created after a certain time (specified as an ISO 8601 timestamp)

updatedBeforestring date-time

Filter for resources updated before a certain time (specified as an ISO 8601 timestamp)

updatedAfterstring date-time

Filter for resources updated after a certain time (specified as an ISO 8601 timestamp)

ownerIdstring[]

The ID of the workspaces to return resources for

environmentIdstring[]

Filter for resources that belong to an environment

cursorstring

The position in the result list to start from when fetching paginated results. For details, see Pagination.

limitinteger

Defaults to 20

The maximum number of items to return. For details, see Pagination.

Response

Successful response

cursorstring required