> ## 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 を一時停止し、スケジュールされた実行を停止します。

`POST /api/v1/cloud/deployments/{id}/pause`

Deployment を一時停止します。一時停止中はスケジュールされた実行が発火しません。Deployment のステータスは `"paused"` になり、`paused_reason` は `{"type": "manual"}` に設定されます。

## パスパラメータ

| パラメータ | 型      | 説明                            |
| ----- | ------ | ----------------------------- |
| `id`  | string | Deployment ID(`dep_` プレフィックス) |

## ヘッダー

| 名称              | 必須 | 値                   |
| --------------- | -- | ------------------- |
| `Authorization` | はい | `Bearer $QODER_PAT` |
| `Content-Type`  | はい | `application/json`  |

## リクエストボディ

リクエストボディは不要です。

## リクエスト例

```bash theme={null}
curl -X POST "https://api.qoder.com/api/v1/cloud/deployments/dep_019ec556114c78f8b60ee34fcb98bf59/pause" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json"
```

## レスポンス例

**HTTP 200 OK**

ステータスが更新された完全な Deployment オブジェクトを返します。

```json theme={null}
{
  "agent": {
    "id": "agent_019eb4d4a06d747c865d5800b9c57ae2",
    "type": "agent",
    "version": 1
  },
  "archived_at": null,
  "created_at": "2026-06-14T08:53:32Z",
  "description": "Deployment created for API documentation verification",
  "environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
  "environment_variables": "",
  "id": "dep_019ec556114c78f8b60ee34fcb98bf59",
  "initial_events": [
    {
      "content": [
        {
          "type": "text",
          "text": "Generate today's status report"
        }
      ],
      "type": "user.message"
    }
  ],
  "metadata": {},
  "name": "api-doc-verification-deployment-v2",
  "paused_reason": {
    "type": "manual"
  },
  "resources": [],
  "schedule": {
    "expression": "30 9 * * 1-5",
    "last_run_at": "2026-06-14T08:54:06Z",
    "timezone": "Asia/Shanghai",
    "type": "cron",
    "upcoming_runs_at": [
      "2026-06-15T01:30:00Z",
      "2026-06-16T01:30:00Z",
      "2026-06-17T01:30:00Z",
      "2026-06-18T01:30:00Z",
      "2026-06-19T01:30:00Z"
    ]
  },
  "status": "paused",
  "type": "deployment",
  "updated_at": "2026-06-14T08:54:22Z",
  "vault_ids": []
}
```

## エラー

| HTTP | type                   | 説明                    |
| ---- | ---------------------- | --------------------- |
| 401  | `authentication_error` | PAT が無効または期限切れ        |
| 404  | `not_found_error`      | Deployment が存在しない     |
| 409  | `conflict_error`       | Deployment はすでに一時停止済み |

完全なエラーエンベロープについては [エラー](/ja/cloud-agents/api/conventions/errors) を参照してください。

## 関連項目

<CardGroup cols={2}>
  <Card title="Deployment の一時停止解除" icon="play" href="/ja/cloud-agents/api/deployments/unpause">
    一時停止された Deployment を再開します。
  </Card>

  <Card title="Deployment のアーカイブ" icon="archive" href="/ja/cloud-agents/api/deployments/archive">
    Deployment をアーカイブして以後の実行を完全に停止します。
  </Card>

  <Card title="Deployment の取得" icon="layer-group" href="/ja/cloud-agents/api/deployments/get">
    `status` と `paused_reason` フィールドで一時停止状態を確認します。
  </Card>

  <Card title="エラー" icon="circle-exclamation" href="/ja/cloud-agents/api/conventions/errors">
    共通のエラーエンベロープ仕様を参照します。
  </Card>
</CardGroup>