Environments REST API Guide

List Environments

get

Retrieve a list of environments from authorized projects.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
typestring · enumOptional

type of environment

Possible values:
filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses
200

List of environments from authorized projects

application/json
Responseall of
get
/v3/environments

Get environment of a model

get

Retrieve details of a specific environment associated with a model.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
env_idstring · uuidRequired

environment id path parameter

Responses
200

Details of the environment associated with the specified ID

application/json
Responseall of
get
/v3/environments/{env_id}

List of environments of a model

get

Retrieve a list of environments associated with a specific model.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
model_idstring · uuidRequired

model id path parameter

Query parameters
typestring · enumOptional

type of environment

Possible values:
filterstringOptional

Allows you to filter by any field.

searchstringOptional

Allows you to search by any field.

orderingstringOptional

Allows you to order results by any field. For desc order prefix field name with - and provide comman separated values for multiple fields

limitintegerOptional

Limit for the pagination

offsetintegerOptional

Offset for the pagination

Responses
200

List of environments associated with the specified model

application/json
Responseall of
get
/v3/models/{model_id}/environments

Last updated

Was this helpful?