POST /api/v1/cloud/memory_stores/{memory_store_id}/archive
Archives an active Memory Store and returns the updated Memory Store object.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
memory_store_id | string | Yes | Memory Store ID with the memstore_ prefix |
Example request
Example response
HTTP 200 OK
Response
Returns the archived Memory Store object. Its status changes to archived and archived_at is populated.
Notes
No request body is required. After archival, the store remains readable, but memories can no longer be created or updated in it.
Error codes
| HTTP | type | Trigger |
|---|---|---|
| 401 | authentication_error | Missing or invalid authentication token |
| 404 | not_found_error | No Memory Store exists with the specified ID |
| 409 | invalid_request_error | The Memory Store is already archived |