diff options
| author | Erik Johnston <erik@matrix.org> | 2016-07-28 14:56:09 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2016-07-28 14:56:09 +0100 |
| commit | 367b594183c553436bb0338e9f26e42fa46424dc (patch) | |
| tree | 3ea4ce1cee7367553655cdcc7eaa5d1378363d46 /docs/admin_api/purge_history_api.rst | |
| parent | Add authors to changelog (diff) | |
| download | synapse-367b594183c553436bb0338e9f26e42fa46424dc.tar.xz | |
Add some basic admin API docs
Diffstat (limited to 'docs/admin_api/purge_history_api.rst')
| -rw-r--r-- | docs/admin_api/purge_history_api.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/admin_api/purge_history_api.rst b/docs/admin_api/purge_history_api.rst new file mode 100644 index 0000000000..986efe40f9 --- /dev/null +++ b/docs/admin_api/purge_history_api.rst @@ -0,0 +1,15 @@ +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. |