Skip to main content

Environments

statusboolean

Whether the request succeeded.

Example: true
messagestring

Human-readable description of the result.

Example: Getting environments successful
environments object[]

An array of objects each containing details about an environment.

  • Array [
  • idinteger

    Unique numeric identifier for the environment.

    Example: 3287
    namestring

    Name of the environment.

    Example: example-environment
    regionstring

    Region the environment is in: CANADA-1, NORWAY-1, or US-1.

    Example: NORWAY-1
    created_atstring<date-time>

    ISO 8601 UTC timestamp marking when the environment was created.

    Example: 2026-05-06T16:04:09Z
    features object

    Feature flags enabled in the environment.

    network_optimisedboolean

    Whether high-speed networking is enabled for the environment.

    Example: false
    green_statusstring

    Indicator of how much of the region's capacity is running on green energy.

    Possible values: [GREEN, PARTIALLY_GREEN, NOT_GREEN]

    Example: GREEN
  • ]
  • pageintegernullable

    1-indexed page number of the current result set.

    page_sizeintegernullable

    Number of items per page in the current result set.

    countinteger

    Number of items returned in the current page.

    Example: 11
    Environments
    {
    "status": true,
    "message": "Getting environments successful",
    "environments": [
    {
    "id": 3287,
    "name": "example-environment",
    "region": "NORWAY-1",
    "created_at": "2026-05-06T16:04:09Z",
    "features": {
    "network_optimised": false,
    "green_status": "GREEN"
    }
    }
    ],
    "page": 0,
    "page_size": 0,
    "count": 11
    }