POST /api/v1/forward/sessions/{session_id}/archive
セッションをアーカイブします。アーカイブ済みのセッションは既定で一覧結果から除外されます。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Idempotency-Key | No | 安全でないリクエスト向けの任意の冪等性キー。 |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id | string | Yes | Session ID。 |
Example request
Example response
HTTP 200 OKResponse fields
archived_at が設定されたアーカイブ済みの Session オブジェクトを返します。
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT が無効または期限切れ。 |
| 404 | not_found_error | session_not_found | Session が存在しない。 |
| 409 | conflict_error | session_archived | Session はすでにアーカイブ済み。 |
Notes
- 現在の設計では復元用のエンドポイントは提供していません。
- アーカイブ済みのセッションをクエリするには、List Sessions で
include_archived=trueを使用してください。