2021-07-07 11:44:14 +02:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Media - Synapse< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "../favicon.svg" >
< link rel = "shortcut icon" href = "../favicon.png" >
< link rel = "stylesheet" href = "../css/variables.css" >
< link rel = "stylesheet" href = "../css/general.css" >
< link rel = "stylesheet" href = "../css/chrome.css" >
< link rel = "stylesheet" href = "../css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "../FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "../fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "../highlight.css" >
< link rel = "stylesheet" href = "../tomorrow-night.css" >
< link rel = "stylesheet" href = "../ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< link rel = "stylesheet" href = "../docs/website_files/table-of-contents.css" >
< link rel = "stylesheet" href = "../docs/website_files/remove-nav-buttons.css" >
< link rel = "stylesheet" href = "../docs/website_files/indent-section-headers.css" >
2023-12-12 18:29:11 +01:00
< link rel = "stylesheet" href = "../docs/website_files/version-picker.css" >
2021-07-07 11:44:14 +02:00
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-11-17 14:44:41 +01:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < li class = "part-title" > Introduction< / li > < li class = "chapter-item expanded " > < a href = "../welcome_and_overview.html" > Welcome and Overview< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Setup< / li > < li class = "chapter-item expanded " > < a href = "../setup/installation.html" > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../postgres.html" > Using Postgres< / a > < / li > < li class = "chapter-item expanded " > < a href = "../reverse_proxy.html" > Configuring a Reverse Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../setup/forward_proxy.html" > Configuring a Forward/Outbound Proxy< / a > < / li > < li class = "chapter-item expanded " > < a href = "../turn-howto.html" > Configuring a Turn Server< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../setup/turn/coturn.html" > coturn TURN server< / a > < / li > < li class = "chapter-item expanded " > < a href = "../setup/turn/eturnal.html" > eturnal TURN server< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../delegate.html" > Delegation< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Upgrading< / li > < li class = "chapter-item expanded " > < a href = "../upgrade.html" > Upgrading between Synapse Versions< / a > < / li > < li class = "chapter-item expanded affix " > < li class = "part-title" > Usage< / li > < li class = "chapter-item expanded " > < a href = "../federate.html" > Federation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/index.html" > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../usage/configuration/config_documentation.html" > Configuration Manual< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/homeserver_sample_config.html" > Homeserver Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/logging_sample_config.html" > Logging Sample Config File< / a > < / li > < li class = "chapter-item expanded " > < a href = "../structured_logging.html" > Structured Logging< / a > < / li > < li class = "chapter-item expanded " > < a href = "../templates.html" > Templates< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/index.html" > User Authentication< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/index.html" > Single-Sign On< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../openid.html" > OpenID Connect< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/saml.html" > SAML< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/single_sign_on/cas.html" > CAS< / a > < / li > < li class = "chapter-item expanded " > < a href = "../sso_mapping_providers.html" > SSO Mapping Providers< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../password_auth_providers.html" > Password Auth Providers< / a > < / li > < li class = "chapter-item expanded " > < a href = "../jwt.html" > JSON Web Tokens< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage/configuration/user_authentication/refresh_tokens.html" > Refresh Tokens< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../CAPTCHA_SETUP.html" > Registration Captcha< / a > < / li > < li class = "chapter-item expanded " > < a href = "../application_services.html" > Application Services< / a > < / li > < li class = "chapter-item expanded " > < a href = "../server_notices.html" > Server Notices< / a > < / li > < li class = "chapter-item expanded " > < a href = "../consent_tracking.html" > Consent Tracking< / a > < / li > < li class = "chapter-item expanded " > < a href = "../user_directory.html" > User Directory< / a > < / li > < li class = "chapter-item expanded " > < a href = "../message_retention_policies.html" > Message Retention Policies< / a > < / li > < li class = "chapter-item expanded " > < a href = "../modules/index.html" > Pluggable Modules< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../modules/writing_a_module.html" > Writing a module< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded "
2021-07-07 11:44:14 +02:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
2023-12-12 18:29:11 +01:00
< div class = "version-picker" >
< div class = "dropdown" >
< div class = "select" >
< span > < / span >
< i class = "fa fa-chevron-down" > < / i >
< / div >
< input type = "hidden" name = "version" >
< ul class = "dropdown-menu" >
<!-- Versions will be added dynamically in version - picker.js -->
< / ul >
< / div >
< / div >
2021-07-07 11:44:14 +02:00
< / div >
< h1 class = "menu-title" > Synapse< / h1 >
< div class = "right-buttons" >
< a href = "../print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/matrix-org/synapse/edit/develop/docs/admin_api/media_admin_api.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
2024-04-26 17:36:35 +02:00
<!-- BEGIN OUTDATED WARNING -->
< div style = "padding: 2em; margin: 2em; border: 3px solid red;" class = "content" >
< h1 > This documentation may be out of date!< / h1 >
< p >
This documentation site is for the versions of Synapse maintained by the < em > Matrix.org Foundation< / em > (< a href = "https://github.com/matrix-org/synapse" > github.com/matrix-org/synapse< / a > ), available under the Apache 2.0 licence.
< / p >
< p >
Since version 1.99, Synapse is now maintained by < em > Element< / em > under a new licence (< a href = "https://github.com/element-hq/synapse" > github.com/element-hq/synapse< / a > ).
< / p >
< p >
If you are interested in the documentation for a later version of Synapse, please < a href = "https://element-hq.github.io/synapse/latest/admin_api/media_admin_api.html" > click here to navigate to this same page on the latest Element Synapse documentation site< / a > , if it's available.
< / p >
< / div >
<!-- END OUTDATED WARNING -->
< div id = "content" class = "content" >
2021-07-07 11:44:14 +02:00
< main >
<!-- Page table of contents -->
< div class = "sidetoc" >
< nav class = "pagetoc" > < / nav >
< / div >
2022-02-08 14:26:46 +01:00
< h1 id = "querying-media" > < a class = "header" href = "#querying-media" > Querying media< / a > < / h1 >
2021-07-07 11:44:14 +02:00
< p > These APIs allow extracting media information from the homeserver.< / p >
2022-02-22 13:26:55 +01:00
< p > Details about the format of the < code > media_id< / code > and storage of the media in the file system
are documented under < a href = "../media_repository.html" > media repository< / a > .< / p >
2022-02-08 14:26:46 +01:00
< p > To use it, you will need to authenticate by providing an < code > access_token< / code >
2023-01-17 13:46:31 +01:00
for a server admin: see < a href = "../usage/administration/admin_api/" > Admin API< / a > .< / p >
2021-07-07 11:44:14 +02:00
< h2 id = "list-all-media-in-a-room" > < a class = "header" href = "#list-all-media-in-a-room" > List all media in a room< / a > < / h2 >
< p > This API gets a list of known media in a room.
However, it only shows media from unencrypted events or rooms.< / p >
< p > The API is:< / p >
< pre > < code > GET /_synapse/admin/v1/room/< room_id> /media
< / code > < / pre >
< p > The API returns a JSON body like the following:< / p >
< pre > < code class = "language-json" > {
" local" : [
" mxc://localhost/xwvutsrqponmlkjihgfedcba" ,
" mxc://localhost/abcdefghijklmnopqrstuvwx"
],
" remote" : [
" mxc://matrix.org/xwvutsrqponmlkjihgfedcba" ,
" mxc://matrix.org/abcdefghijklmnopqrstuvwx"
]
}
< / code > < / pre >
< h2 id = "list-all-media-uploaded-by-a-user" > < a class = "header" href = "#list-all-media-uploaded-by-a-user" > List all media uploaded by a user< / a > < / h2 >
< p > Listing all media that has been uploaded by a local user can be achieved through
2021-08-24 18:08:09 +02:00
the use of the
< a href = "user_admin_api.html#list-media-uploaded-by-a-user" > List media uploaded by a user< / a >
2021-07-07 11:44:14 +02:00
Admin API.< / p >
< h1 id = "quarantine-media" > < a class = "header" href = "#quarantine-media" > Quarantine media< / a > < / h1 >
< p > Quarantining media means that it is marked as inaccessible by users. It applies
to any local media, and any locally-cached copies of remote media.< / p >
< p > The media file itself (and any thumbnails) is not deleted from the server.< / p >
< h2 id = "quarantining-media-by-id" > < a class = "header" href = "#quarantining-media-by-id" > Quarantining media by ID< / a > < / h2 >
< p > This API quarantines a single piece of local or remote media.< / p >
< p > Request:< / p >
< pre > < code > POST /_synapse/admin/v1/media/quarantine/< server_name> /< media_id>
{}
< / code > < / pre >
< p > Where < code > server_name< / code > is in the form of < code > example.org< / code > , and < code > media_id< / code > is in the
form of < code > abcdefg12345...< / code > .< / p >
< p > Response:< / p >
< pre > < code class = "language-json" > {}
< / code > < / pre >
< h2 id = "remove-media-from-quarantine-by-id" > < a class = "header" href = "#remove-media-from-quarantine-by-id" > Remove media from quarantine by ID< / a > < / h2 >
< p > This API removes a single piece of local or remote media from quarantine.< / p >
< p > Request:< / p >
< pre > < code > POST /_synapse/admin/v1/media/unquarantine/< server_name> /< media_id>
{}
< / code > < / pre >
< p > Where < code > server_name< / code > is in the form of < code > example.org< / code > , and < code > media_id< / code > is in the
form of < code > abcdefg12345...< / code > .< / p >
< p > Response:< / p >
< pre > < code class = "language-json" > {}
< / code > < / pre >
< h2 id = "quarantining-media-in-a-room" > < a class = "header" href = "#quarantining-media-in-a-room" > Quarantining media in a room< / a > < / h2 >
< p > This API quarantines all local and remote media in a room.< / p >
< p > Request:< / p >
< pre > < code > POST /_synapse/admin/v1/room/< room_id> /media/quarantine
{}
< / code > < / pre >
< p > Where < code > room_id< / code > is in the form of < code > !roomid12345:example.org< / code > .< / p >
< p > Response:< / p >
< pre > < code class = "language-json" > {
" num_quarantined" : 10
}
< / code > < / pre >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > num_quarantined< / code > : integer - The number of media items successfully quarantined< / li >
< / ul >
< p > Note that there is a legacy endpoint, < code > POST /_synapse/admin/v1/quarantine_media/< room_id> < / code > , that operates the same.
However, it is deprecated and may be removed in a future release.< / p >
< h2 id = "quarantining-all-media-of-a-user" > < a class = "header" href = "#quarantining-all-media-of-a-user" > Quarantining all media of a user< / a > < / h2 >
< p > This API quarantines all < em > local< / em > media that a < em > local< / em > user has uploaded. That is to say, if
you would like to quarantine media uploaded by a user on a remote homeserver, you should
instead use one of the other APIs.< / p >
< p > Request:< / p >
< pre > < code > POST /_synapse/admin/v1/user/< user_id> /media/quarantine
{}
< / code > < / pre >
< p > URL Parameters< / p >
< ul >
< li > < code > user_id< / code > : string - User ID in the form of < code > @bob:example.org< / code > < / li >
< / ul >
< p > Response:< / p >
< pre > < code class = "language-json" > {
" num_quarantined" : 10
}
< / code > < / pre >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > num_quarantined< / code > : integer - The number of media items successfully quarantined< / li >
< / ul >
< h2 id = "protecting-media-from-being-quarantined" > < a class = "header" href = "#protecting-media-from-being-quarantined" > Protecting media from being quarantined< / a > < / h2 >
< p > This API protects a single piece of local media from being quarantined using the
above APIs. This is useful for sticker packs and other shared media which you do
not want to get quarantined, especially when
< a href = "#quarantining-media-in-a-room" > quarantining media in a room< / a > .< / p >
< p > Request:< / p >
< pre > < code > POST /_synapse/admin/v1/media/protect/< media_id>
{}
< / code > < / pre >
< p > Where < code > media_id< / code > is in the form of < code > abcdefg12345...< / code > .< / p >
< p > Response:< / p >
< pre > < code class = "language-json" > {}
< / code > < / pre >
< h2 id = "unprotecting-media-from-being-quarantined" > < a class = "header" href = "#unprotecting-media-from-being-quarantined" > Unprotecting media from being quarantined< / a > < / h2 >
< p > This API reverts the protection of a media.< / p >
< p > Request:< / p >
< pre > < code > POST /_synapse/admin/v1/media/unprotect/< media_id>
{}
< / code > < / pre >
< p > Where < code > media_id< / code > is in the form of < code > abcdefg12345...< / code > .< / p >
< p > Response:< / p >
< pre > < code class = "language-json" > {}
< / code > < / pre >
< h1 id = "delete-local-media" > < a class = "header" href = "#delete-local-media" > Delete local media< / a > < / h1 >
< p > This API deletes the < em > local< / em > media from the disk of your own server.
This includes any local thumbnails and copies of media downloaded from
remote homeservers.
This API will not affect media that has been uploaded to external
media repositories (e.g https://github.com/turt2live/matrix-media-repo/).
See also < a href = "#purge-remote-media-api" > Purge Remote Media API< / a > .< / p >
< h2 id = "delete-a-specific-local-media" > < a class = "header" href = "#delete-a-specific-local-media" > Delete a specific local media< / a > < / h2 >
< p > Delete a specific < code > media_id< / code > .< / p >
< p > Request:< / p >
< pre > < code > DELETE /_synapse/admin/v1/media/< server_name> /< media_id>
{}
< / code > < / pre >
< p > URL Parameters< / p >
< ul >
< li > < code > server_name< / code > : string - The name of your local server (e.g < code > matrix.org< / code > )< / li >
< li > < code > media_id< / code > : string - The ID of the media (e.g < code > abcdefghijklmnopqrstuvwx< / code > )< / li >
< / ul >
< p > Response:< / p >
< pre > < code class = "language-json" > {
" deleted_media" : [
" abcdefghijklmnopqrstuvwx"
],
" total" : 1
}
< / code > < / pre >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > deleted_media< / code > : an array of strings - List of deleted < code > media_id< / code > < / li >
< li > < code > total< / code > : integer - Total number of deleted < code > media_id< / code > < / li >
< / ul >
< h2 id = "delete-local-media-by-date-or-size" > < a class = "header" href = "#delete-local-media-by-date-or-size" > Delete local media by date or size< / a > < / h2 >
< p > Request:< / p >
2023-02-28 19:14:51 +01:00
< pre > < code > POST /_synapse/admin/v1/media/delete?before_ts=< before_ts>
{}
< / code > < / pre >
< p > < em > Deprecated in Synapse v1.78.0:< / em > This API is available at the deprecated endpoint:< / p >
2021-07-07 11:44:14 +02:00
< pre > < code > POST /_synapse/admin/v1/media/< server_name> /delete?before_ts=< before_ts>
{}
< / code > < / pre >
< p > URL Parameters< / p >
< ul >
2023-02-28 19:14:51 +01:00
< li > < code > server_name< / code > : string - The name of your local server (e.g < code > matrix.org< / code > ). < em > Deprecated in Synapse v1.78.0.< / em > < / li >
2021-11-02 15:27:50 +01:00
< li > < code > before_ts< / code > : string representing a positive integer - Unix timestamp in milliseconds.
2021-07-07 11:44:14 +02:00
Files that were last used before this timestamp will be deleted. It is the timestamp of
2021-11-02 15:27:50 +01:00
last access, not the timestamp when the file was created.< / li >
2021-07-07 11:44:14 +02:00
< li > < code > size_gt< / code > : Optional - string representing a positive integer - Size of the media in bytes.
Files that are larger will be deleted. Defaults to < code > 0< / code > .< / li >
< li > < code > keep_profiles< / code > : Optional - string representing a boolean - Switch to also delete files
that are still used in image data (e.g user profile, room avatar).
If < code > false< / code > these files will be deleted. Defaults to < code > true< / code > .< / li >
< / ul >
< p > Response:< / p >
< pre > < code class = "language-json" > {
" deleted_media" : [
" abcdefghijklmnopqrstuvwx" ,
" abcdefghijklmnopqrstuvwz"
],
" total" : 2
}
< / code > < / pre >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > deleted_media< / code > : an array of strings - List of deleted < code > media_id< / code > < / li >
< li > < code > total< / code > : integer - Total number of deleted < code > media_id< / code > < / li >
< / ul >
2021-08-24 18:08:09 +02:00
< h2 id = "delete-media-uploaded-by-a-user" > < a class = "header" href = "#delete-media-uploaded-by-a-user" > Delete media uploaded by a user< / a > < / h2 >
< p > You can find details of how to delete multiple media uploaded by a user in
< a href = "user_admin_api.html#delete-media-uploaded-by-a-user" > User Admin API< / a > .< / p >
2021-07-07 11:44:14 +02:00
< h1 id = "purge-remote-media-api" > < a class = "header" href = "#purge-remote-media-api" > Purge Remote Media API< / a > < / h1 >
< p > The purge remote media API allows server admins to purge old cached remote media.< / p >
< p > The API is:< / p >
< pre > < code > POST /_synapse/admin/v1/purge_media_cache?before_ts=< unix_timestamp_in_ms>
{}
< / code > < / pre >
< p > URL Parameters< / p >
< ul >
2022-05-31 15:28:14 +02:00
< li > < code > before_ts< / code > : string representing a positive integer - Unix timestamp in milliseconds.
2021-07-07 11:44:14 +02:00
All cached media that was last accessed before this timestamp will be removed.< / li >
< / ul >
< p > Response:< / p >
< pre > < code class = "language-json" > {
" deleted" : 10
}
< / code > < / pre >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > deleted< / code > : integer - The number of media items successfully deleted< / li >
< / ul >
< p > If the user re-requests purged remote media, synapse will re-request the media
from the originating server.< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2023-05-09 19:43:57 +02:00
< a rel = "prev" href = "../admin_api/experimental_features.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-07-07 11:44:14 +02:00
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../admin_api/purge_history_api.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2023-05-09 19:43:57 +02:00
< a rel = "prev" href = "../admin_api/experimental_features.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-07-07 11:44:14 +02:00
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../admin_api/purge_history_api.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< script type = "text/javascript" src = "../docs/website_files/table-of-contents.js" > < / script >
2023-12-12 18:29:11 +01:00
< script type = "text/javascript" src = "../docs/website_files/version-picker.js" > < / script >
< script type = "text/javascript" src = "../docs/website_files/version.js" > < / script >
2021-07-07 11:44:14 +02:00
< / body >
2023-12-12 18:29:11 +01:00
< / html >
