v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
environments

List environments

Lists all environments for the workspace associated with the Management API key.

get/environments

Query parameters

cursorstring

Cursor token used for pagination. Response will contain items appearing after the given cursor.

limitnumber

Sets the maximum number of items contained in a single page.

Headers

X-API-Versionstring required

Management API version.

Response

List of environments matching the given query.

Example response

{
  "data": [
    {
      "id": "ae_rrETjdWcfqI6AFsk",
      "name": "Default environment",
      "description": "Production environment",
      "limit_value": 100000,
      "restricted_at": "2024-05-31T01:24:39.506Z",
      "created_at": "2024-05-31T01:24:39.506Z",
      "updated_at": "2024-05-31T01:24:39.506Z"
    }
  ],
  "metadata": {
    "pagination": {
      "next_cursor": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI"
    }
  }
}