synapse/docs/admin_api/purge_remote_media.rst

18 lines
462 B
ReStructuredText
Raw Normal View History

2016-07-28 07:56:09 -06:00
Purge Remote Media API
======================
The purge remote media API allows server admins to purge old cached remote
media.
2016-07-28 07:56:09 -06:00
The API is::
2019-05-01 08:18:58 -06:00
POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms>&access_token=<access_token>
2016-07-28 07:56:09 -06:00
{}
2016-07-28 07:56:09 -06:00
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.