Skip to content
Snippets Groups Projects
Unverified Commit 620f98b6 authored by Richard van der Hoff's avatar Richard van der Hoff Committed by GitHub
Browse files

write some docs for the quarantine_media api (#6458)

parent fdec84aa
No related branches found
No related tags found
No related merge requests found
Write some docs for the quarantine_media api.
......@@ -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.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment