kaslo/synapse
1
0
Fork 0
Code Wiki Activity

write some docs for the quarantine_media api (#6458)

Browse Source 
* commit '620f98b65':
  write some docs for the quarantine_media api (#6458)
This commit is contained in:
Andrew Morgan
2020-03-19 16:08:07 +00:00
parent be3e14a46a 620f98b65b
commit f57cfa30f4
2 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/6458.doc Normal file
View File

@@ -0,0 +1 @@
Write some docs for the quarantine_media api.

17
docs/admin_api/media_admin_api.md
View File

@@ -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.