Archive a Forward Memory Store.
Archives an active Memory Store. An archived Store remains readable, but its Memory entries cannot be created or updated.
Mounts are checked before archiving. If the Store is still mounted to any
No request body is required.
HTTP 200 OK
Returns the archived Memory Store object, with
Archiving a system-managed default Store (
(identity, template) pair, the endpoint returns 409. Detach every mount before archiving the Store.
Path
POST /api/v1/forward/memory_stores/{memory_store_id}/archive
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or admin SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
memory_store_id | string | Yes | Memory Store ID (memstore_...). |
Example request
Example response
HTTP 200 OK
Response
Returns the archived Memory Store object, with status set to archived and archived_at populated.
Notes
Archiving a system-managed default Store (system_managed=true) causes Forward to create a new empty default Store the next time a Session is created for that (identity, template) pair. The historical Memory entries become orphaned. Do not archive a system-managed default Store unless you no longer need those Memories.
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | A path parameter is invalid. |
| 401 | authentication_error | The authentication token is missing or invalid. |
| 403 | permission_error | The caller cannot access the resource. |
| 404 | not_found_error | The Store does not exist or is not visible across users. |
| 409 | conflict_error | The Store is already archived or is still mounted to an (identity, template) pair. |
| 500/502/503 | api_error | Forward or a dependent service failed. |