mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-11-25 11:05:49 +03:00
Code Issues Projects Releases Packages Wiki Activity
synapse/docs/admin_api/purge_history_api.rst
Richard van der Hoff 8fd1a32456 Fix typos in purge api & doc 
* It's supposed to be purge_local_events, not ..._history
* Fix the doc to have valid json
2018-02-13 13:09:39 +00:00

866 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.

By default, events sent by local users are not deleted, as they may represent the only copies of this content in existence. (Events sent by remote users are deleted, and room state data before the cutoff is always removed).

To delete local events as well, set delete_local_events in the body:

{
    "delete_local_events": true
}