---
title: "List containers"
method: GET
path: "/containers"
tags: ["Containers"]
---

# List containers

`GET /containers`

## Request

- Base URL: `https://api.hypamoon.com/api/v1`
- URL: `https://api.hypamoon.com/api/v1/containers`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://app.hypamoon.com/oauth/authorize`, token URL `https://api.hypamoon.com/oauth/token`, scopes: `sites:read`)

The containers of the project, newest first.

## Response `200`

The containers.

- object
  - `data` object[], required
    - `id` string, uuid, required
    - `site_id` string, uuid, required
    - `name` string, required
    - `url` string, required
    - `mode` 'live' | 'test', required
    - `status` 'deploying' | 'running' | 'failed' | 'suspended', required
    - `suspended` object
      - `reason` 'blocked' | 'site_offline' | 'plan' | 'balance', required
      - `since` string, required
      - `next_step` string, required
    - `version` integer, required: The live version; 0 until the first deploy is live.
    - `instance_type` string, required
    - `instances` integer, required
    - `always_on` boolean, required
    - `sleep_after` string, required
    - `port` integer, required
    - `health_path` string, required
    - `allowed_hosts` string[], required
    - `secrets` string[], required
    - `env_secrets` object[], required
      - `secret` string, required
      - `as` string, required
    - `env_names` string[], required: Names of the plain environment variables (never the values of secrets).
    - `created_at` string, required
    - `updated_at` string, required

## Other responses

- `401`: Unauthorized: unauthorized, missing_api_key, invalid_api_key, api_key_revoked, project_deleted.
- `403`: Forbidden: project_not_enabled, key_mode_mismatch, missing_scope, verification_required.
- `429`: Too Many Requests: rate_limited.
- `500`: Internal Server Error: internal_error.
- `503`: Service Unavailable: service_unavailable.

---

[API](https://skmtc.dev/hypamoon/apis/hypamoon-api.md) · [All operations](https://skmtc.dev/hypamoon/apis/hypamoon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hypamoon/apis/hypamoon-api/revisions/9f0b90004c06?raw)