summary refs log tree commit diff
path: root/docs/admin_api/purge_remote_media.rst
blob: 00cb6b0589d48cd843f480c7b8a19312805d184d (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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.