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

パスパラメータ

ヘッダー

リクエストボディ

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

リクエスト例

レスポンス例

HTTP 200 OK archived_at が設定された完全な Deployment オブジェクトを返します。

エラー

完全なエラーエンベロープについては エラー を参照してください。

関連項目

Deployment 一覧

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

Deployment の一時停止

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

Deployment の取得

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

エラー

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