summary refs log tree commit diff
path: root/docs/admin_api/purge_room.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/admin_api/purge_room.md')
-rw-r--r--docs/admin_api/purge_room.md18
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.