List Environments

get

https://{Domain}/api/iacp/v3/environments

This endpoint lists account environments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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

query

string

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.

sort

array of strings

The comma-separated list of attributes.

sort

include

array of strings

The comma-separated list of relationship paths.

include

fields

object

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.

Responses

404

Account not found or user unauthorized to perform action.

4XX

Client error.

5XX

Server error.

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

200Success.