mirror of
https://git.anonymousland.org/anonymousland/synapse.git
synced 2024-12-28 06:09:22 -05:00
8fd1a32456
* It's supposed to be purge_local_events, not ..._history * Fix the doc to have valid json
28 lines
866 B
ReStructuredText
28 lines
866 B
ReStructuredText
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:
|
|
|
|
.. code:: json
|
|
|
|
{
|
|
"delete_local_events": true
|
|
}
|