Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

write some docs for the quarantine_media api #6458

Merged
merged 1 commit into from
Dec 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/6458.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Write some docs for the quarantine_media api.
17 changes: 17 additions & 0 deletions docs/admin_api/media_admin_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.