forked-synapse/docs/admin_api/purge_remote_media.rst

21 lines
566 B
ReStructuredText
Raw Normal View History

2016-07-28 09:56:09 -04:00
Purge Remote Media API
======================
The purge remote media API allows server admins to purge old cached remote
media.
2016-07-28 09:56:09 -04:00
The API is::
POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms>
2016-07-28 09:56:09 -04:00
{}
2016-07-28 09:56:09 -04:00
\... which will remove all cached media that was last accessed before
2016-07-28 09:56:09 -04:00
``<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>`_.
2016-07-28 09:56:09 -04:00
If the user re-requests purged remote media, synapse will re-request the media
from the originating server.