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

Environments REST API Guide

PreviousAlert Rules REST API Guide NextExplainability REST API Guide

Last updated 11 days ago

Was this helpful?

List Environments

get

Retrieve a list of environments from authorized projects.

Authorizations

Query parameters

typestring · enumoptional

type of environment

Options: PRE_PRODUCTION, PRODUCTION

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v3/environments' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

500

{
  "api_version": "2.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-03-28T21:54:43.309Z",
        "updated_at": "2025-03-28T21:54:43.309Z"
      }
    ]
  }
}

List of environments from authorized projects

Get environment of a model

get

Retrieve details of a specific environment associated with a model.

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 YOUR_SECRET_TOKEN'

200

400

404

500

{
  "api_version": "2.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-03-28T21:54:43.309Z",
    "updated_at": "2025-03-28T21:54:43.309Z"
  }
}

Details of the environment associated with the specified ID

List of environments of a model

get

Retrieve a list of environments associated with a specific model.

Authorizations

Path parameters

model_idstring · uuidrequired

model id path parameter

Query parameters

typestring · enumoptional

type of environment

Options: PRE_PRODUCTION, PRODUCTION

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

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

500

{
  "api_version": "2.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-03-28T21:54:43.309Z",
        "updated_at": "2025-03-28T21:54:43.309Z"
      }
    ]
  }
}

List of environments associated with the specified model