diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2020-02-11 17:56:04 +0000 |
|---|---|---|
| committer | Brendan Abolivier <babolivier@matrix.org> | 2020-02-11 17:56:04 +0000 |
| commit | 6b21986e4ee999eb3669ec90f6db3bdfa7ce71a1 (patch) | |
| tree | 6398c4b5371b704fc77b6fb1f87c0da886c9c679 /docs/admin_api | |
| parent | Changelog (diff) | |
| download | synapse-6b21986e4ee999eb3669ec90f6db3bdfa7ce71a1.tar.xz | |
Also spell it out in the purge history API doc
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..f2c4dc03ac 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, in order to not break the room, this API won't delete the last +message sent to it. + The API is: ``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]`` |