List environments

List environments visible to the caller within a project.

GET /api/projects/{projectSlug}/environments HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request GET \
  'https://app.helicarrier.xyz/api/projects/my-project/environments' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/projects/my-project/environments",
  {
    method: "GET",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`
    }
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "GET",
    "https://app.helicarrier.xyz/api/projects/my-project/environments",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 200

[
  {
    "id": "env_example",
    "projectId": "prj_example",
    "name": "Staging",
    "slug": "staging",
    "isDefault": false
  }
]

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with project access, or a project key for this project. Environment restrictions still apply.

Authorization: Bearer <key> Key setup ↗

Path parameters

projectSlug string required

Project slug.

Response 200

Returns environments visible to the caller. Use a returned slug to select an environment in a project read or creation request.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

id string

Unique identifier of this resource.

projectId string

Project that owns the resource.

name string

Human-readable resource name.

slug string

URL-safe resource identifier.

isDefault boolean

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

404

The resource does not exist or is not visible to this caller.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`list_environments`

Required MCP arguments: projectSlug. Send path, query, and body fields together as tool arguments.

Connect your agent ↗

import os import requests response = requests.request( "GET", "https://app.helicarrier.xyz/api/projects/my-project/environments", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.