diff options
| author | Richard van der Hoff <richard@matrix.org> | 2019-09-19 15:05:31 +0100 |
|---|---|---|
| committer | Richard van der Hoff <richard@matrix.org> | 2019-09-19 15:05:31 +0100 |
| commit | b789c7eb03aaadee8d5e2f289a4c100fc01f71b8 (patch) | |
| tree | da9216150b667cd83fbc416b2431671fb5215d86 /docs/admin_api/purge_room.md | |
| parent | Add changelog (diff) | |
| parent | fix sample config (diff) | |
| download | synapse-b789c7eb03aaadee8d5e2f289a4c100fc01f71b8.tar.xz | |
Merge branch 'develop' into rav/saml_config_cleanup
Diffstat (limited to 'docs/admin_api/purge_room.md')
| -rw-r--r-- | docs/admin_api/purge_room.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/admin_api/purge_room.md b/docs/admin_api/purge_room.md new file mode 100644 index 0000000000..64ea7b6a64 --- /dev/null +++ b/docs/admin_api/purge_room.md @@ -0,0 +1,18 @@ +Purge room API +============== + +This API will remove all trace of a room from your database. + +All local users must have left the room before it can be removed. + +The API is: + +``` +POST /_synapse/admin/v1/purge_room + +{ + "room_id": "!room:id" +} +``` + +You must authenticate using the access token of an admin user. |