> ## Documentation Index
> Fetch the complete documentation index at: https://docs.qoder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 列出 Deployment

> 列出当前账号下所有 Deployment，支持游标分页。

`GET /api/v1/cloud/deployments`

列出当前账号下所有 Deployment，按创建时间降序排列（最新在前）。默认不包含已归档的 Deployment。

## 请求头

| 头部              | 必选 | 说明             |
| --------------- | -- | -------------- |
| `Authorization` | 是  | `Bearer <PAT>` |

## 查询参数

| 参数                 | 类型      | 必选 | 说明                                                           |
| ------------------ | ------- | -- | ------------------------------------------------------------ |
| `limit`            | integer | 否  | 每页最大记录数，默认 20，范围 1-100。超过 100 返回 `400 invalid_request_error` |
| `page`             | string  | 否  | `next_page` 返回的游标值。不能与 `before_id` 或 `after_id` 同时使用         |
| `after_id`         | string  | 否  | 游标分页：返回此 ID 之后的记录                                            |
| `before_id`        | string  | 否  | 游标分页：返回此 ID 之前的记录                                            |
| `status`           | string  | 否  | 按状态筛选：`active`、`paused`                                      |
| `include_archived` | boolean | 否  | 是否包含已归档 Deployment，默认 `false`                                |
| `agent_id`         | string  | 否  | 按 Agent ID 筛选                                                |
| `created_at[gte]`  | string  | 否  | 仅返回创建时间大于等于该时间的 Deployment（ISO 8601）                         |
| `created_at[lte]`  | string  | 否  | 仅返回创建时间小于等于该时间的 Deployment（ISO 8601）                         |

## 示例请求

```bash theme={null}
curl -X GET "https://api.qoder.com/api/v1/cloud/deployments?limit=2" \
  -H "Authorization: Bearer $QODER_PAT"
```

## 示例响应

**HTTP 200 OK**

```json theme={null}
{
  "data": [
    {
      "agent": {
        "id": "agent_019ebb21ef8e7df6a559052c94875160",
        "type": "agent",
        "version": 1
      },
      "archived_at": null,
      "created_at": "2026-06-14T08:58:01Z",
      "description": "Deployment created for API documentation verification",
      "environment_id": "env_019e49a1780171daac1e6b01f290ac2b",
      "environment_variables": "",
      "id": "dep_019ec55a2b687b3f94eee77dd77e4b2a",
      "initial_events": [
        {
          "content": [
            {
              "type": "text",
              "text": "Generate today's status report"
            }
          ],
          "type": "user.message"
        }
      ],
      "metadata": {},
      "name": "api-doc-verification-deployment",
      "paused_reason": null,
      "resources": [],
      "schedule": {
        "expression": "0 9 * * *",
        "timezone": "Asia/Shanghai",
        "type": "cron",
        "upcoming_runs_at": [
          "2026-06-15T01:00:00Z",
          "2026-06-16T01:00:00Z",
          "2026-06-17T01:00:00Z",
          "2026-06-18T01:00:00Z",
          "2026-06-19T01:00:00Z"
        ]
      },
      "status": "active",
      "type": "deployment",
      "updated_at": "2026-06-14T08:58:01Z",
      "vault_ids": []
    }
  ],
  "first_id": "dep_019ec55a2b687b3f94eee77dd77e4b2a",
  "has_more": true,
  "last_id": "dep_019ec53748f7784bac33f208c0f66982",
  "next_page": "dep_019ec53748f7784bac33f208c0f66982"
}
```

## 响应字段

| 字段          | 类型            | 说明                                                 |
| ----------- | ------------- | -------------------------------------------------- |
| `data`      | array         | Deployment 对象列表                                    |
| `first_id`  | string        | 当前页第一条记录的 ID                                       |
| `last_id`   | string        | 当前页最后一条记录的 ID                                      |
| `has_more`  | boolean       | 是否还有更多记录                                           |
| `next_page` | string 或 null | 下一页游标值（`has_more` 为 true 时与 `last_id` 相同，否则为 null） |

使用 `next_page` 作为下次请求的 `page` 参数向前翻页。

## 错误码

| HTTP | type                   | 触发条件      |
| ---- | ---------------------- | --------- |
| 401  | `authentication_error` | PAT 无效或过期 |

完整错误信封说明详见 [错误参考](/zh/cloud-agents/api/conventions/errors)。

## 相关

<CardGroup cols={2}>
  <Card title="创建 Deployment" icon="plus" href="/zh/cloud-agents/api/deployments/create">
    创建新的 cron 或手动触发 Deployment。
  </Card>

  <Card title="获取 Deployment" icon="layer-group" href="/zh/cloud-agents/api/deployments/get">
    查看单个 Deployment 的详细信息。
  </Card>

  <Card title="列出所有 Run" icon="clock" href="/zh/cloud-agents/api/deployments/list-all-runs">
    跨 Deployment 查询所有运行记录。
  </Card>

  <Card title="错误参考" icon="circle-exclamation" href="/zh/cloud-agents/api/conventions/errors">
    所有 API 错误码与错误信封约定。
  </Card>
</CardGroup>