明示した ID で最大 50 件の Forward Schedule をアーカイブします。
POST /api/v1/forward/schedules/archive
Schedule と Schedule Run を物理削除せずにアーカイブします。PAT と管理者 SAT のみ使用でき、Identity-bound SAT は使用できません。
ヘッダー
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または管理者 SAT> |
Content-Type | Yes | application/json |
Idempotency-Key | No | 同じ owner、パス、本文のリクエストを安全に再実行するためのキー。 |
リクエストボディ
| Parameter | Type | Required | Description |
|---|---|---|---|
schedule_ids | array<string> | Yes | 重複排除後に 1~50 件の空でない Schedule ID。 |
400 invalid_request_body になります。
リクエスト例
GET /api/v1/forward/schedules?identity_id=<id>&limit=100 で一覧を取得し、last_id を after_id としてページネーションします。確認した ID を最大 50 件ずつ送信し、各バッチに別の Idempotency-Key を使用してください。1 バッチはアトミックですが、複数バッチ全体はアトミックではありません。現在の owner を対象とする場合は identity_id を省略します。処理中に新しい Schedule が作成される可能性がある場合は、各巡回後に最初のページから再取得し、対象がなくなるまで繰り返してください。
archived_count は未アーカイブからアーカイブに変更された Schedule の数です。すでにアーカイブ済みの対象は再計上されません。
レスポンス例
アーカイブの動作
activeとpausedの両方をアーカイブできます。archived_atが設定され、次回実行時刻が消去され、新しい Run は作成されません。- owner 内ですべての ID を解決してから更新します。存在しない ID や別 owner の ID が 1 件でもあると、バッチ全体が 404 になります。
- アーカイブ済み ID は no-op です。すべてアーカイブ済みなら
archived_count: 0を返します。 - 既存の
pendingまたはrunningRun はキャンセル、変更、削除されません。 - Schedule は ID または
include_archived=trueで取得でき、履歴 Run も引き続き取得できます。 Idempotency-Keyを省略しても、同じリクエストの再実行は冪等です。同じキーと本文を再利用すると、最初のレスポンスがIdempotency-Replayed: trueとともに返されます。- Forward は
DELETE /api/v1/forward/schedulesを提供せず、Schedule または Schedule Run の物理削除も提供しません。
エラー
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 400 | invalid_request_error | invalid_request_body | JSON が無効、scope や identity_id など未知のフィールド、または追加の JSON 値。 |
| 400 | invalid_request_error | invalid_request | ID が空、または重複排除後の件数が 1~50 ではありません。 |
| 401 | authentication_error | authentication_required | PAT または SAT が無効または期限切れです。 |
| 403 | permission_error | identity_mismatch | Identity-bound SAT が管理者 API を呼び出しました。 |
| 404 | not_found_error | schedule_not_found | Schedule が存在しないか、別の owner に属します。 |
| 409 | conflict_error | idempotency_key_reused | 同じキーを異なる本文に再利用しました。 |

