diff options
Diffstat (limited to 'develop/usage')
| -rw-r--r-- | develop/usage/administration/admin_api/federation.html | 30 |
1 files changed, 29 insertions, 1 deletions
diff --git a/develop/usage/administration/admin_api/federation.html b/develop/usage/administration/admin_api/federation.html index 7e40251d64..87aace72db 100644 --- a/develop/usage/administration/admin_api/federation.html +++ b/develop/usage/administration/admin_api/federation.html @@ -258,7 +258,7 @@ to this destination, or <code>null</code> if this information has not been track <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> -<h1 id="destination-details-api"><a class="header" href="#destination-details-api">Destination Details API</a></h1> +<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> @@ -272,9 +272,37 @@ to this destination, or <code>null</code> if this information has not been track "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="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> |