mirror of
https://mau.dev/maunium/synapse.git
synced 2024-12-15 01:13:50 +01:00
write some docs for the quarantine_media api (#6458)
This commit is contained in:
parent
fdec84aa42
commit
620f98b65b
2 changed files with 18 additions and 0 deletions
1
changelog.d/6458.doc
Normal file
1
changelog.d/6458.doc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
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.
|
||||||
|
|
Loading…
Reference in a new issue