mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-21 12:14:29 +03:00
Code Issues Projects Releases Packages Wiki Activity
synapse/docs/admin_api/purge_history_api.rst
Erik Johnston 367b594183 Add some basic admin API docs
2016-07-28 14:56:09 +01:00

505 B
Raw Blame History

Purge History API

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

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.