diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2020-02-12 20:12:20 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-12 20:12:20 +0000 |
| commit | 6cd34da8b1138715d152539eacff653f6fdeb3b2 (patch) | |
| tree | 0fd18c26cfc8669466f8507080513a9479080bea /docs/admin_api | |
| parent | Return a 404 for admin api user lookup if user not found (#6901) (diff) | |
| parent | Rephrase (diff) | |
| download | synapse-6cd34da8b1138715d152539eacff653f6fdeb3b2.tar.xz | |
Merge pull request #6891 from matrix-org/babolivier/retention-doc-amend
Spell out that the last event sent to a room won't be deleted by a purge
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/purge_history_api.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/admin_api/purge_history_api.rst b/docs/admin_api/purge_history_api.rst index f7be226fd9..e2a620c54f 100644 --- a/docs/admin_api/purge_history_api.rst +++ b/docs/admin_api/purge_history_api.rst @@ -8,6 +8,9 @@ Depending on the amount of history being purged a call to the API may take several minutes or longer. During this period users will not be able to paginate further back in the room from the point being purged from. +Note that Synapse requires at least one message in each room, so it will never +delete the last message in a room. + The API is: ``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]`` |