diff options
| author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2021-06-02 19:50:35 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-02 18:50:35 +0100 |
| commit | 0284d2a2976e3d58e9970fdb7590f98a2556326d (patch) | |
| tree | 3ec3dbd410149ea9cbfd3e67addcc99b1bed539b /docs/admin_api | |
| parent | github actions: summarize Sytest results in an easy-to-read format (#10094) (diff) | |
| download | synapse-0284d2a2976e3d58e9970fdb7590f98a2556326d.tar.xz | |
Add new admin APIs to remove media by media ID from quarantine. (#10044)
Related to: #6681, #5956, #10040 Signed-off-by: Dirk Klimpel dirk@klimpel.org
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/media_admin_api.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md index d1b7e390d5..7709f3d8c7 100644 --- a/docs/admin_api/media_admin_api.md +++ b/docs/admin_api/media_admin_api.md @@ -4,6 +4,7 @@ * [List all media uploaded by a user](#list-all-media-uploaded-by-a-user) - [Quarantine media](#quarantine-media) * [Quarantining media by ID](#quarantining-media-by-id) + * [Remove media from quarantine by ID](#remove-media-from-quarantine-by-id) * [Quarantining media in a room](#quarantining-media-in-a-room) * [Quarantining all media of a user](#quarantining-all-media-of-a-user) * [Protecting media from being quarantined](#protecting-media-from-being-quarantined) @@ -77,6 +78,27 @@ Response: {} ``` +## Remove media from quarantine by ID + +This API removes a single piece of local or remote media from quarantine. + +Request: + +``` +POST /_synapse/admin/v1/media/unquarantine/<server_name>/<media_id> + +{} +``` + +Where `server_name` is in the form of `example.org`, and `media_id` is in the +form of `abcdefg12345...`. + +Response: + +```json +{} +``` + ## Quarantining media in a room This API quarantines all local and remote media in a room. |