mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-27 12:08:32 +03:00
Code Issues Projects Releases Packages Wiki Activity
synapse/docs/admin_api/purge_history_api.rst
Ander Punnar b2e02084b8 make it absolutely clear that Purge History API does not remove all traces of events and message contents 
because this topic pops up too often

#890 #1621 #1730 #2260 #2315 and so on
2017-10-14 13:25:42 +03:00

704 B
Raw Blame History

Purge History API

The purge history API allows server admins to purge historic events from their database, reclaiming disk space.

NB! This will not delete local events (locally sent messages content etc) from the database, but will remove lots of the metadata about them and does dramatically reduce the on disk space usage

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.

The API is simply:

POST /_matrix/client/r0/admin/purge_history/<room_id>/<event_id>

including an access_token of a server admin.