メインコンテンツへスキップ
POST /api/v1/cloud/deployments/{id} マージパッチセマンティクスで Deployment を更新します。リクエストボディに含まれるフィールドのみが変更され、省略されたフィールドは現在の値を保持します。
本エンドポイントは CMA との整合のため POST(PATCH ではなく) を使用します。指定されたフィールドのみが部分更新として適用されます。

​
パスパラメータ

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

​
ヘッダー

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

​
リクエストボディ

すべてのフィールドは任意です。変更したいフィールドのみを含めてください。
フィールド型説明
namestring新しい名前(最大 256 文字)
descriptionstring or null新しい説明
agentstring or object新しい Agent 参照(文字列 ID または {id, type, version} オブジェクト)。オブジェクト形式では type: "agent" を含む必要があります。
environment_idstring新しい Environment ID
scheduleobject更新後のスケジュール設定(すべてのサブフィールド type、expression、timezone を含む必要あり)
initial_eventsarray新しい initial events 配列(1-50 個)
resourcesarray更新後のリソース
vault_idsarray更新後の vault ID
metadataobject or nullマージパッチ形式の文字列メタデータ。文字列値はキーを upsert し、key→null はキーを削除し、metadata: null はすべてのメタデータをクリアします。
environment_variablesstring or nullDeployment レベルの環境変数を置き換えます。null は既存の変数をクリアします。セルフホスト環境ではサポートされません。

​
リクエスト例

curl -X POST "https://api.qoder.com/api/v1/cloud/deployments/dep_019ec556114c78f8b60ee34fcb98bf59" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "api-doc-verification-deployment-v2",
    "schedule": {
      "type": "cron",
      "expression": "30 9 * * 1-5",
      "timezone": "Asia/Shanghai"
    }
  }'

​
レスポンス例

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",
  "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": null,
  "resources": [],
  "schedule": {
    "expression": "30 9 * * 1-5",
    "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": "active",
  "type": "deployment",
  "updated_at": "2026-06-14T08:54:05Z",
  "vault_ids": []
}

​
エラー

HTTPtype説明
400invalid_request_error無効なフィールド値、type: "agent" を含まないオブジェクト形式の agent、空の名前、無効な cron 式、または参照先 Agent/Environment がアーカイブ済み
401authentication_errorPAT が無効または期限切れ
404not_found_errorDeployment が存在しない
完全なエラーエンベロープについては エラー を参照してください。

​
関連項目

Deployment の取得

ID を指定して単一の Deployment 詳細を取得します。

Deployment の一時停止

スケジュールされた実行を一時停止します。

Deployment のアーカイブ

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

エラー

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