From 2c2e1e9f187010cd846abf06adaefe23c4930b04 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 25 Jan 2022 12:06:57 +0000 Subject: deploy: 0d6cfea9b867a14fa0fa885b04c8cbfdb4a7c4a9 --- .../usage/administration/admin_api/federation.html | 30 +++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) (limited to 'develop/usage/administration/admin_api/federation.html') 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 null if this information has not been track
  • next_token: string representing a positive integer - Indication for pagination. See above.
  • total - integer - Total number of destinations.
    • -

    Destination Details API

    +

    Destination Details API

    This API gets the retry timing info for a specific remote server.

    The API is:

    GET /_synapse/admin/v1/federation/destinations/<destination>
@@ -272,9 +272,37 @@ to this destination, or null if this information has not been track
    "last_successful_stream_ordering": null
 }
    +

    Parameters

    +

    The following parameters should be set in the URL:

    +

    Response

    The response fields are the same like in the destinations array in List of destinations response.

    +

    Reset connection timeout

    +

    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 +(exponential backoff).

    +

    Admins can cancel the cooldown period with this API.

    +

    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 retry_interval. +The connection must have previously run into an error and retry_last_ts +(Destination Details API) must not be equal to 0.

    +

    The connection attempt is carried out in the background and can take a while +even if the API already returns the http status 200.

    +

    The API is:

    +
    POST /_synapse/admin/v1/federation/destinations/<destination>/reset_connection
+
+{}
+
    +

    Parameters

    +

    The following parameters should be set in the URL:

    + -- cgit 1.5.1