---
title: "List Deployments"
method: GET
path: "/api/v1/deployments"
tags: ["deployments"]
---

# List Deployments

`GET /api/v1/deployments`

## Request

- Base URL: `https://api.mengi.cloud` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mengi.cloud/api/v1/deployments`
- Auth: none declared

## Query parameters

- `skip` integer
- `limit` integer
- `cluster_id` string, uuid, nullable
- `status` 'pending' | 'provisioning' | 'promoting' | 'running' | 'stopped' | 'failed' | 'error' | 'migrating' | 'deleting'

## Response `200`

Successful Response

- DeploymentListResponse
  - `deployments` DeploymentResponse[], required
    - `id` string, uuid, required
    - `user_id` string, uuid, required
    - `organization_id` string, uuid, nullable
    - `cluster_id` string, uuid, required
    - `name` string, required
    - `app_type` 'web_app' | 'api' | 'database' | 'static_site' | 'container' | 'helm', required
    - `status` 'pending' | 'provisioning' | 'promoting' | 'running' | 'stopped' | 'failed' | 'error' | 'migrating' | 'deleting', required
    - `config` object, nullable
    - `values_yaml` string, nullable
    - `git_path` string, nullable
    - `endpoint_url` string, nullable
    - `error_message` string, nullable
    - `cpu_request` number, nullable
    - `memory_request_mb` integer, nullable
    - `replicas` integer, nullable
    - `container_port` integer, nullable
    - `storage_size_gb` integer, nullable
    - `command` string[], nullable
    - `args` string[], nullable
    - `deployment_type` string, nullable
    - `helm_repo_url` string, nullable
    - `helm_chart_name` string, nullable
    - `helm_chart_version` string, nullable
    - `custom_values_yaml` string, nullable
    - `image_update_strategy` string, nullable
    - `image_update_constraint` string, nullable
    - `image_allow_tags` string, nullable
    - `image_ignore_tags` string, nullable
    - `is_adopted` boolean
    - `source_namespace` string, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `provider` string, nullable
    - `region` string, nullable
    - `cluster_status` string, nullable
    - `cluster_error` string, nullable
  - `total` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mengi/apis/mengi-cloud.md) · [All operations](https://skmtc.dev/mengi/apis/mengi-cloud/llms.txt) · [OpenAPI document](https://skmtc.dev/mengi/apis/mengi-cloud/revisions/4ae9b375cdbb?raw)