👨‍💻 API Reference 📣 Release Notes 📺 Request a Demo

Environments REST API Guide

PreviousAlert Rules REST API Guide NextExplainability REST API Guide

Last updated 3 months ago

Was this helpful?

List Environments

Retrieve a list of environments from authorized projects.

get

/v3/environments

Authorizations

Query parameters

typeenum

type of environment

Options: PRE_PRODUCTION, PRODUCTION

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

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

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/environments' \
  --header 'Authorization: Bearer <token>'

200

400

401

403

500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "PRE_PRODUCTION",
        "row_count": 1,
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "created_at": "2025-02-06T09:51:12.986Z",
        "updated_at": "2025-02-06T09:51:12.986Z"
      }
    ]
  }
}

List of environments from authorized projects

Get environment of a model

Retrieve details of a specific environment associated with a model.

get

/v3/environments/{env_id}

Authorizations

Path parameters

env_idstring uuidrequired

environment id path parameter

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/environments/{env_id}' \
  --header 'Authorization: Bearer <token>'

200

400

404

500

{
  "api_version": "3.0",
  "kind": "NORMAL",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "type": "PRE_PRODUCTION",
    "row_count": 1,
    "model": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "version": "text"
    },
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "organization": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "created_at": "2025-02-06T09:51:12.986Z",
    "updated_at": "2025-02-06T09:51:12.986Z"
  }
}

Details of the environment associated with the specified ID

List of environments of a model

Retrieve a list of environments associated with a specific model.

get

/v3/models/{model_id}/environments

Authorizations

Path parameters

model_idstring uuidrequired

model id path parameter

Query parameters

typeenum

type of environment

Options: PRE_PRODUCTION, PRODUCTION

filterstring

Allows you to filter by any field.

searchstring

Allows you to search by any field.

orderingstring

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

limitinteger

Limit for the pagination

offsetinteger

Offset for the pagination

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/models/{model_id}/environments' \
  --header 'Authorization: Bearer <token>'

200

400

401

403

404

500

{
  "api_version": "3.0",
  "kind": "PAGINATED",
  "data": {
    "items": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "PRE_PRODUCTION",
        "row_count": 1,
        "model": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "version": "text"
        },
        "project": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "organization": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        },
        "created_at": "2025-02-06T09:51:12.986Z",
        "updated_at": "2025-02-06T09:51:12.986Z"
      }
    ]
  }
}

List of environments associated with the specified model