2016-07-28 15:56:09 +02:00
|
|
|
Purge Remote Media API
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
The purge remote media API allows server admins to purge old cached remote
|
2017-01-20 13:15:50 +01:00
|
|
|
media.
|
2016-07-28 15:56:09 +02:00
|
|
|
|
|
|
|
|
The API is::
|
|
|
|
|
|
2020-06-05 18:31:05 +02:00
|
|
|
POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms>
|
2016-07-28 15:56:09 +02:00
|
|
|
|
2017-01-20 13:15:50 +01:00
|
|
|
{}
|
2016-07-28 15:56:09 +02:00
|
|
|
|
2020-06-05 18:31:05 +02:00
|
|
|
\... which will remove all cached media that was last accessed before
|
2016-07-28 15:56:09 +02:00
|
|
|
``<unix_timestamp_in_ms>``.
|
|
|
|
|
|
2020-06-05 18:31:05 +02:00
|
|
|
To use it, you will need to authenticate by providing an ``access_token`` for a
|
|
|
|
|
server admin: see `README.rst <README.rst>`_.
|
|
|
|
|
|
2016-07-28 15:56:09 +02:00
|
|
|
If the user re-requests purged remote media, synapse will re-request the media
|
|
|
|
|
from the originating server.
|
