POST /api/v1/forward/sessions/{session_id}/archive
Archives a session. Archived sessions are excluded from list results by default.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Idempotency-Key | No | Optional idempotency key for unsafe requests. |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
session_id | string | Yes | Session ID. |
Example request
Example response
HTTP 200 OKResponse fields
Returns the archived Session object witharchived_at set.
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT invalid or expired. |
| 404 | not_found_error | session_not_found | Session does not exist. |
| 409 | conflict_error | session_archived | Session is already archived. |
Notes
- Current design does not provide a restore endpoint.
- Use
include_archived=trueon List Sessions to query archived sessions.