メインコンテンツへスキップ
POST /v1/deployments/{id}/pause Deployment を一時停止します。一時停止中はスケジュールされた実行が発火しません。Deployment のステータスは "paused" になり、paused_reason は {"type": "manual"} に設定されます。

​
パスパラメータ

パラメータ型説明
idstringDeployment ID(dep_ プレフィックス)

​
ヘッダー

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

​
リクエストボディ

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

​
リクエスト例

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 オブジェクトを返します。 
{
  "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",
  "id": "dep_019ec556114c78f8b60ee34fcb98bf59",
  "initial_events": [
    {
      "content": "Generate today's status report",
      "type": "user.message"
    }
  ],
  "metadata": {
    "cas_config": {
      "config": {
        "max_concurrent": 1,
        "max_retries": 0,
        "timeout_ms": 300000
      },
      "session_strategy": "new_session",
      "stats": {
        "consecutive_failures": 0,
        "last_triggered_at": "2026-06-14T08:54:06Z",
        "next_trigger_at": "2026-06-15T01:30:00Z",
        "total_failures": 0,
        "total_runs": 1
      }
    }
  },
  "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": []
}

​
エラー

HTTPtype説明
401authentication_errorPAT が無効または期限切れ
404not_found_errorDeployment が存在しない
409conflict_errorDeployment はすでに一時停止済み
完全なエラーエンベロープについては エラー を参照してください。

​
関連項目

Deployment の一時停止解除

一時停止された Deployment を再開します。

Deployment のアーカイブ

Deployment をアーカイブして以後の実行を完全に停止します。

Deployment の取得

status と paused_reason フィールドで一時停止状態を確認します。

エラー

共通のエラーエンベロープ仕様を参照します。