summaryrefslogtreecommitdiff
path: root/docs/admin_api/media_admin_api.md
diff options
context:
space:
mode:
authorAndrej Shadura <andrewsh@debian.org>2019-12-13 16:59:46 +0100
committerAndrej Shadura <andrewsh@debian.org>2019-12-13 16:59:46 +0100
commitee7f97e3d5b8cd1dbce640434316d03d0abc14ae (patch)
tree69f2f7e286fcbf2cba86014bbab0374643e81818 /docs/admin_api/media_admin_api.md
parentbd05112be2f458e45a1733501753575106e56a89 (diff)
New upstream version 1.7.0
Diffstat (limited to 'docs/admin_api/media_admin_api.md')
-rw-r--r--docs/admin_api/media_admin_api.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md
index 5e9f8e5d..8b3666d5 100644
--- a/docs/admin_api/media_admin_api.md
+++ b/docs/admin_api/media_admin_api.md
@@ -21,3 +21,20 @@ It returns a JSON body like the following:
]
}
```
+
+# Quarantine media in a room
+
+This API 'quarantines' all the media in a room.
+
+The API is:
+
+```
+POST /_synapse/admin/v1/quarantine_media/<room_id>
+
+{}
+```
+
+Quarantining media means that it is marked as inaccessible by users. It applies
+to any local media, and any locally-cached copies of remote media.
+
+The media file itself (and any thumbnails) is not deleted from the server.