Sign in
OpenAPI 3.1.02026-08-1584337456.5 KB

9dfc2be2007f

Environments
MCP

List Environments

Authorization scope: environment:list

Get list of environments entities for an account

📖 Instructions for usage

list_environments

List all environments for an account.
get/v1/accounts/{account_id}/environments

Path parameters

account_idstring required

Query parameters

include_deletedboolean
is_deployable_environmentsboolean
items_per_pageinteger

The number of items per page in the paginated list.

The number of items per page in the paginated list.

pageinteger

The current page number in the paginated list.

The current page number in the paginated list.

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

account_idstring required

The account id

Example response

{
  "items": [
    {
      "_id": "633ede20f1fc5500111fd7b3",
      "account": "62e7f4352c13160013dc39be",
      "user_created": "62e7f4352c13160013dc39be",
      "cross_id": "62e7f4352c13160013dc39be",
      "environment_name": "Dev Environment",
      "description": "Development environment for new rivers",
      "variables": {
        "aws_file_zone": "Rivery-rivery",
        "azure_file_zone": "Rivery-rivery",
        "days_ago": "0",
        "gcs_file_zone": "Rivery-rivery",
        "hours_offset": "0"
      },
      "deleted_by": "62e7f4352c13160013dc39be",
      "is_default": true,
      "updated_by": "62e7f4352c13160013dc39be",
      "is_delete_lock": true
    }
  ]
}