2022-08-23 11:51:17 +03:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Federation - 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-11 17:55:52 +03:00
< link rel = "stylesheet" href = "../../../docs/website_files/version-picker.css" >
2022-08-23 11:51:17 +03: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" >
< 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 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 " > < a href = "../../../modules/spam_checker_
< / 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-11 17:55:52 +03: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 >
2022-08-23 11:51:17 +03: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/usage/administration/admin_api/federation.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 >
< div id = "content" class = "content" >
< main >
<!-- Page table of contents -->
< div class = "sidetoc" >
< nav class = "pagetoc" > < / nav >
< / div >
< h1 id = "federation-api" > < a class = "header" href = "#federation-api" > Federation API< / a > < / h1 >
< p > This API allows a server administrator to manage Synapse's federation with other homeservers.< / p >
< p > Note: This API is new, experimental and " subject to change" .< / p >
< h2 id = "list-of-destinations" > < a class = "header" href = "#list-of-destinations" > List of destinations< / a > < / h2 >
< p > This API gets the current destination retry timing info for all remote servers.< / p >
< p > The list contains all the servers with which the server federates,
regardless of whether an error occurred or not.
If an error occurs, it may take up to 20 minutes for the error to be displayed here,
as a complete retry must have failed.< / p >
< p > The API is:< / p >
< p > A standard request with no filtering:< / p >
< pre > < code > GET /_synapse/admin/v1/federation/destinations
< / code > < / pre >
< p > A response body like the following is returned:< / p >
< pre > < code class = "language-json" > {
" destinations" :[
{
" destination" : " matrix.org" ,
" retry_last_ts" : 1557332397936,
" retry_interval" : 3000000,
" failure_ts" : 1557329397936,
" last_successful_stream_ordering" : null
}
],
" total" : 1
}
< / code > < / pre >
< p > To paginate, check for < code > next_token< / code > and if present, call the endpoint again
with < code > from< / code > set to the value of < code > next_token< / code > . This will return a new page.< / p >
< p > If the endpoint does not return a < code > next_token< / code > then there are no more destinations
to paginate through.< / p >
< p > < strong > Parameters< / strong > < / p >
< p > The following query parameters are available:< / p >
< ul >
< li > < code > from< / code > - Offset in the returned list. Defaults to < code > 0< / code > .< / li >
< li > < code > limit< / code > - Maximum amount of destinations to return. Defaults to < code > 100< / code > .< / li >
< li > < code > order_by< / code > - The method in which to sort the returned list of destinations.
Valid values are:
< ul >
< li > < code > destination< / code > - Destinations are ordered alphabetically by remote server name.
This is the default.< / li >
< li > < code > retry_last_ts< / code > - Destinations are ordered by time of last retry attempt in ms.< / li >
< li > < code > retry_interval< / code > - Destinations are ordered by how long until next retry in ms.< / li >
< li > < code > failure_ts< / code > - Destinations are ordered by when the server started failing in ms.< / li >
< li > < code > last_successful_stream_ordering< / code > - Destinations are ordered by the stream ordering
of the most recent successfully-sent PDU.< / li >
< / ul >
< / li >
< li > < code > dir< / code > - Direction of room order. Either < code > f< / code > for forwards or < code > b< / code > for backwards. Setting
this value to < code > b< / code > will reverse the above sort order. Defaults to < code > f< / code > .< / li >
< / ul >
< p > < em > Caution:< / em > The database only has an index on the column < code > destination< / code > .
This means that if a different sort order is used,
this can cause a large load on the database, especially for large environments.< / p >
< p > < strong > Response< / strong > < / p >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > destinations< / code > - An array of objects, each containing information about a destination.
Destination objects contain the following fields:
< ul >
< li > < code > destination< / code > - string - Name of the remote server to federate.< / li >
< li > < code > retry_last_ts< / code > - integer - The last time Synapse tried and failed to reach the
remote server, in ms. This is < code > 0< / code > if the last attempt to communicate with the
remote server was successful.< / li >
< li > < code > retry_interval< / code > - integer - How long since the last time Synapse tried to reach
the remote server before trying again, in ms. This is < code > 0< / code > if no further retrying occuring.< / li >
< li > < code > failure_ts< / code > - nullable integer - The first time Synapse tried and failed to reach the
remote server, in ms. This is < code > null< / code > if communication with the remote server has never failed.< / li >
< li > < code > last_successful_stream_ordering< / code > - nullable integer - The stream ordering of the most
recent successfully-sent < a href = "understanding_synapse_through_grafana_graphs.html#federation" > PDU< / a >
to this destination, or < code > null< / code > if this information has not been tracked yet.< / li >
< / ul >
< / li >
< li > < code > next_token< / code > : string representing a positive integer - Indication for pagination. See above.< / li >
< li > < code > total< / code > - integer - Total number of destinations.< / li >
< / ul >
< h2 id = "destination-details-api" > < a class = "header" href = "#destination-details-api" > Destination Details API< / a > < / h2 >
< p > This API gets the retry timing info for a specific remote server.< / p >
< p > The API is:< / p >
< pre > < code > GET /_synapse/admin/v1/federation/destinations/< destination>
< / code > < / pre >
< p > A response body like the following is returned:< / p >
< pre > < code class = "language-json" > {
" destination" : " matrix.org" ,
" retry_last_ts" : 1557332397936,
" retry_interval" : 3000000,
" failure_ts" : 1557329397936,
" last_successful_stream_ordering" : null
}
< / code > < / pre >
< p > < strong > Parameters< / strong > < / p >
< p > The following parameters should be set in the URL:< / p >
< ul >
< li > < code > destination< / code > - Name of the remote server.< / li >
< / ul >
< p > < strong > Response< / strong > < / p >
< p > The response fields are the same like in the < code > destinations< / code > array in
< a href = "#list-of-destinations" > List of destinations< / a > response.< / p >
< h2 id = "destination-rooms" > < a class = "header" href = "#destination-rooms" > Destination rooms< / a > < / h2 >
< p > This API gets the rooms that federate with a specific remote server.< / p >
< p > The API is:< / p >
< pre > < code > GET /_synapse/admin/v1/federation/destinations/< destination> /rooms
< / code > < / pre >
< p > A response body like the following is returned:< / p >
< pre > < code class = "language-json" > {
" rooms" :[
{
" room_id" : " !OGEhHVWSdvArJzumhm:matrix.org" ,
" stream_ordering" : 8326
},
{
" room_id" : " !xYvNcQPhnkrdUmYczI:matrix.org" ,
" stream_ordering" : 93534
}
],
" total" : 2
}
< / code > < / pre >
< p > To paginate, check for < code > next_token< / code > and if present, call the endpoint again
with < code > from< / code > set to the value of < code > next_token< / code > . This will return a new page.< / p >
< p > If the endpoint does not return a < code > next_token< / code > then there are no more destinations
to paginate through.< / p >
< p > < strong > Parameters< / strong > < / p >
< p > The following parameters should be set in the URL:< / p >
< ul >
< li > < code > destination< / code > - Name of the remote server.< / li >
< / ul >
< p > The following query parameters are available:< / p >
< ul >
< li > < code > from< / code > - Offset in the returned list. Defaults to < code > 0< / code > .< / li >
< li > < code > limit< / code > - Maximum amount of destinations to return. Defaults to < code > 100< / code > .< / li >
< li > < code > dir< / code > - Direction of room order by < code > room_id< / code > . Either < code > f< / code > for forwards or < code > b< / code > for
backwards. Defaults to < code > f< / code > .< / li >
< / ul >
< p > < strong > Response< / strong > < / p >
< p > The following fields are returned in the JSON response body:< / p >
< ul >
< li > < code > rooms< / code > - An array of objects, each containing information about a room.
Room objects contain the following fields:
< ul >
< li > < code > room_id< / code > - string - The ID of the room.< / li >
< li > < code > stream_ordering< / code > - integer - The stream ordering of the most recent
successfully-sent < a href = "understanding_synapse_through_grafana_graphs.html#federation" > PDU< / a >
to this destination in this room.< / li >
< / ul >
< / li >
< li > < code > next_token< / code > : string representing a positive integer - Indication for pagination. See above.< / li >
< li > < code > total< / code > - integer - Total number of destinations.< / li >
< / ul >
< h2 id = "reset-connection-timeout" > < a class = "header" href = "#reset-connection-timeout" > Reset connection timeout< / a > < / h2 >
< p > Synapse makes federation requests to other homeservers. If a federation request fails,
Synapse will mark the destination homeserver as offline, preventing any future requests
to that server for a " cooldown" period. This period grows over time if the server
continues to fail its responses
(< a href = "https://en.wikipedia.org/wiki/Exponential_backoff" > exponential backoff< / a > ).< / p >
< p > Admins can cancel the cooldown period with this API.< / p >
< p > This API resets the retry timing for a specific remote server and tries to connect to
the remote server again. It does not wait for the next < code > retry_interval< / code > .
The connection must have previously run into an error and < code > retry_last_ts< / code >
(< a href = "#destination-details-api" > Destination Details API< / a > ) must not be equal to < code > 0< / code > .< / p >
< p > The connection attempt is carried out in the background and can take a while
even if the API already returns the http status 200.< / p >
< p > The API is:< / p >
< pre > < code > POST /_synapse/admin/v1/federation/destinations/< destination> /reset_connection
{}
< / code > < / pre >
< p > < strong > Parameters< / strong > < / p >
< p > The following parameters should be set in the URL:< / p >
< ul >
< li > < code > destination< / code > - Name of the remote server.< / li >
< / ul >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "../../../admin_api/version_api.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../../../manhole.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" >
< a rel = "prev" href = "../../../admin_api/version_api.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "../../../manhole.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-11 17:55:52 +03:00
< script type = "text/javascript" src = "../../../docs/website_files/version-picker.js" > < / script >
< script type = "text/javascript" src = "../../../docs/website_files/version.js" > < / script >
2022-08-23 11:51:17 +03:00
< / body >
2023-12-11 17:55:52 +03:00
< / html >
