Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
environments

List Environments

This endpoint lists account environments.

get/environments

Query parameters

filter[account]string

The ID of the Account

filter[environment]string

The ID of the Environment

filter[latest-run-date]string

Filter by latest run date. Example: filter[latest-run-date]=between:2022-01-01T00:00:00Z,2022-02-01T00:00:00Z

filter[policy-group]string

The ID of the Policy Group.

filter[storage-profile]string

The ID of the Storage Profile.

page[number]string

Page number

page[size]string

Page size

querystring

Query string, search by id, name.

filter[tag]string

Filter environments by tags

filter[name]string

The environment name filter.

filter[favorite]string

Filter environments by favorite status. Set to 'true' to show only favorites, 'false' to exclude favorites.

sort[favorite-first]string

When set to 'true', favorite environments are shown first, followed by non-favorites. Both groups respect the main sort order.

sortstring[]

The comma-separated list of attributes.

includestring[]

The comma-separated list of relationship paths.

accountsstring

The comma-separated list of fields to return in response for Account resource.

agent-poolsstring

The comma-separated list of fields to return in response for AgentPool resource.

drift-detection-schedulestring

The comma-separated list of fields to return in response for DriftDetectionSchedule resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

policy-groupsstring

The comma-separated list of fields to return in response for PolicyGroup resource.

provider-configurationsstring

The comma-separated list of fields to return in response for ProviderConfiguration resource.

storage-profilesstring

The comma-separated list of fields to return in response for StorageProfile resource.

tagsstring

The comma-separated list of fields to return in response for Tag resource.

usersstring

The comma-separated list of fields to return in response for User resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Response

Success.