diff options
author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2020-12-09 17:19:57 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-09 16:19:57 +0000 |
commit | 43bf3c51780a299becde91027e73259eb77b039f (patch) | |
tree | c2fc64b291d9e041d27e95a8c3af37ae13ea1f62 /docs/admin_api/purge_remote_media.rst | |
parent | Merge remote-tracking branch 'origin/master' into develop (diff) | |
download | synapse-43bf3c51780a299becde91027e73259eb77b039f.tar.xz |
Combine related media admin API docs (#8839)
Related: #8810 Also a few small improvements. Signed-off-by: Dirk Klimpel dirk@klimpel.org
Diffstat (limited to 'docs/admin_api/purge_remote_media.rst')
-rw-r--r-- | docs/admin_api/purge_remote_media.rst | 20 |
1 files changed, 0 insertions, 20 deletions
diff --git a/docs/admin_api/purge_remote_media.rst b/docs/admin_api/purge_remote_media.rst deleted file mode 100644 index 00cb6b0589..0000000000 --- a/docs/admin_api/purge_remote_media.rst +++ /dev/null @@ -1,20 +0,0 @@ -Purge Remote Media API -====================== - -The purge remote media API allows server admins to purge old cached remote -media. - -The API is:: - - POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms> - - {} - -\... which will remove all cached media that was last accessed before -``<unix_timestamp_in_ms>``. - -To use it, you will need to authenticate by providing an ``access_token`` for a -server admin: see `README.rst <README.rst>`_. - -If the user re-requests purged remote media, synapse will re-request the media -from the originating server. |