synapse/docs/admin_api/purge_remote_media.rst
Richard van der Hoff 1bc00fd76d
Clarifications to the admin api documentation (#7647)
* Clarify how to authenticate
* path params are not the same thing as query params
* Fix documentation for `/_synapse/admin/v2/users/<user_id>`
2020-06-05 17:31:05 +01:00

566 B

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.

If the user re-requests purged remote media, synapse will re-request the media from the originating server.