diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-12-03 18:20:39 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-03 18:20:39 +0000 |
| commit | 620f98b65b43404ea6bf99f5907170de72707f8a (patch) | |
| tree | 95d8c5cc290bde6998597eacd6c79efa0ce9d456 | |
| parent | Add benchmarks for structured logging performance (#6266) (diff) | |
| download | synapse-620f98b65b43404ea6bf99f5907170de72707f8a.tar.xz | |
write some docs for the quarantine_media api (#6458)
| -rw-r--r-- | changelog.d/6458.doc | 1 | ||||
| -rw-r--r-- | docs/admin_api/media_admin_api.md | 17 |
2 files changed, 18 insertions, 0 deletions
diff --git a/changelog.d/6458.doc b/changelog.d/6458.doc new file mode 100644 index 0000000000..3a9f831d89 --- /dev/null +++ b/changelog.d/6458.doc @@ -0,0 +1 @@ +Write some docs for the quarantine_media api. diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md index 5e9f8e5d84..8b3666d5f5 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. |