diff options
| author | Erik Johnston <erik@matrix.org> | 2016-08-08 13:38:13 +0100 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2016-08-08 13:38:13 +0100 |
| commit | d330d45e2d6f6af33904d42045329303c0cd3828 (patch) | |
| tree | af40c91de6b24b6ff53203fa4b6ccc57159b988f /docs/admin_api/purge_remote_media.rst | |
| parent | Merge pull request #959 from evelynmitchell/patch-1 (diff) | |
| parent | Capatailize HTML (diff) | |
| download | synapse-d330d45e2d6f6af33904d42045329303c0cd3828.tar.xz | |
Merge branch 'release-v0.17.0' of github.com:matrix-org/synapse v0.17.0
Diffstat (limited to 'docs/admin_api/purge_remote_media.rst')
| -rw-r--r-- | docs/admin_api/purge_remote_media.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/admin_api/purge_remote_media.rst b/docs/admin_api/purge_remote_media.rst new file mode 100644 index 0000000000..b26c6a9e7b --- /dev/null +++ b/docs/admin_api/purge_remote_media.rst @@ -0,0 +1,19 @@ +Purge Remote Media API +====================== + +The purge remote media API allows server admins to purge old cached remote +media. + +The API is:: + + POST /_matrix/client/r0/admin/purge_media_cache + + { + "before_ts": <unix_timestamp_in_ms> + } + +Which will remove all cached media that was last accessed before +``<unix_timestamp_in_ms>``. + +If the user re-requests purged remote media, synapse will re-request the media +from the originating server. |