メインコンテンツへスキップ
POST /v1/deployments/{id}/archive Deployment をアーカイブします。アーカイブされた Deployment はスケジュールされた実行がすべて停止され、デフォルトの一覧からは非表示になります（List エンドポイントに include_archived=true を渡すと表示されます）。archived_at タイムスタンプが設定され、upcoming_runs_at は空になります。Deployment 名には _archived_<unix_timestamp> が付加され、元の名前を再利用できるようになります。
API 経由でのアーカイブは取り消せません。現時点でアーカイブ解除エンドポイントはありません。

​
パスパラメータ

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

​
ヘッダー

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

​
リクエストボディ

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

​
リクエスト例

curl -X POST "https://api.qoder.com/api/v1/cloud/deployments/dep_019ec55a2b687b3f94eee77dd77e4b2a/archive" \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json"

​
レスポンス例

HTTP 200 OK archived_at が設定された完全な Deployment オブジェクトを返します。 
{
  "agent": {
    "id": "agent_019ebb21ef8e7df6a559052c94875160",
    "type": "agent",
    "version": 1
  },
  "archived_at": "2026-06-14T08:58:42Z",
  "created_at": "2026-06-14T08:58:01Z",
  "description": "Deployment created for API documentation verification",
  "environment_id": "env_019e49a1780171daac1e6b01f290ac2b",
  "id": "dep_019ec55a2b687b3f94eee77dd77e4b2a",
  "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:58:17Z",
        "next_trigger_at": "2026-06-15T01:30:00Z",
        "total_failures": 0,
        "total_runs": 1
      }
    }
  },
  "name": "api-doc-verification-deployment-v2_archived_1781427523",
  "paused_reason": null,
  "resources": [],
  "schedule": {
    "expression": "30 9 * * 1-5",
    "last_run_at": "2026-06-14T08:58:17Z",
    "timezone": "Asia/Shanghai",
    "type": "cron",
    "upcoming_runs_at": []
  },
  "status": "active",
  "type": "deployment",
  "updated_at": "2026-06-14T08:58:42Z",
  "vault_ids": []
}

​
エラー

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

​
関連項目

Deployment 一覧

include_archived=true でアーカイブ済み Deployment も含めて取得します。

Deployment の一時停止

アーカイブの代わりに一時停止で実行を停止することもできます。

Deployment の取得

アーカイブ後の Deployment 状態を確認します。

エラー

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