diff options
| author | Aaron R <aaron@raim.ist> | 2021-10-20 09:41:48 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-20 14:41:48 +0000 |
| commit | 2c61a318cc46ec38e64d6a497f6077d23b9341bf (patch) | |
| tree | 598e0e293247c14387ab49536ad99a60fd60027c /docs/admin_api | |
| parent | Merge branch 'master' into develop (diff) | |
| download | synapse-2c61a318cc46ec38e64d6a497f6077d23b9341bf.tar.xz | |
Show error when timestamp in seconds is provided to the /purge_media_cache API (#11101)
Diffstat (limited to 'docs/admin_api')
| -rw-r--r-- | docs/admin_api/media_admin_api.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md index ea05bd6e44..60b8bc7379 100644 --- a/docs/admin_api/media_admin_api.md +++ b/docs/admin_api/media_admin_api.md @@ -257,9 +257,9 @@ POST /_synapse/admin/v1/media/<server_name>/delete?before_ts=<before_ts> URL Parameters * `server_name`: string - The name of your local server (e.g `matrix.org`). -* `before_ts`: string representing a positive integer - Unix timestamp in ms. +* `before_ts`: string representing a positive integer - Unix timestamp in milliseconds. Files that were last used before this timestamp will be deleted. It is the timestamp of -last access and not the timestamp creation. +last access, not the timestamp when the file was created. * `size_gt`: Optional - string representing a positive integer - Size of the media in bytes. Files that are larger will be deleted. Defaults to `0`. * `keep_profiles`: Optional - string representing a boolean - Switch to also delete files @@ -302,7 +302,7 @@ POST /_synapse/admin/v1/purge_media_cache?before_ts=<unix_timestamp_in_ms> URL Parameters -* `unix_timestamp_in_ms`: string representing a positive integer - Unix timestamp in ms. +* `unix_timestamp_in_ms`: string representing a positive integer - Unix timestamp in milliseconds. All cached media that was last accessed before this timestamp will be removed. Response: |