diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-06-05 17:31:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-05 17:31:05 +0100 |
| commit | 1bc00fd76d1741477ff8ae4f2cc68102d483014c (patch) | |
| tree | ab3eacc6d4bed99a6ef4b3fe20db9e7e059e0a41 /docs/admin_api/purge_remote_media.rst | |
| parent | Update to the stable SSO prefix for UI Auth. (#7630) (diff) | |
| download | synapse-1bc00fd76d1741477ff8ae4f2cc68102d483014c.tar.xz | |
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>`
Diffstat (limited to 'docs/admin_api/purge_remote_media.rst')
| -rw-r--r-- | docs/admin_api/purge_remote_media.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/admin_api/purge_remote_media.rst b/docs/admin_api/purge_remote_media.rst index dacd5bc8fb..00cb6b0589 100644 --- a/docs/admin_api/purge_remote_media.rst +++ b/docs/admin_api/purge_remote_media.rst @@ -6,12 +6,15 @@ media. The API is:: - POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms>&access_token=<access_token> + POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms> {} -Which will remove all cached media that was last accessed before +\... 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. |