From 9061d49ebbefffeee2de5178461086224f178a24 Mon Sep 17 00:00:00 2001 From: babolivier Date: Tue, 8 Feb 2022 13:26:46 +0000 Subject: deploy: 0b561a0ea1384db214c274f45b160c538d2ab65d --- .../usage/administration/admin_api/federation.html | 81 +++++++++++++++++++++- 1 file changed, 80 insertions(+), 1 deletion(-) (limited to 'latest/usage/administration/admin_api/federation.html') diff --git a/latest/usage/administration/admin_api/federation.html b/latest/usage/administration/admin_api/federation.html index 7e40251d64..db48793600 100644 --- a/latest/usage/administration/admin_api/federation.html +++ b/latest/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,88 @@ 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.

    +

    Destination rooms

    +

    This API gets the rooms that federate with a specific remote server.

    +

    The API is:

    +
    GET /_synapse/admin/v1/federation/destinations/<destination>/rooms
+
    +

    A response body like the following is returned:

    +
    {
+   "rooms":[
+      {
+         "room_id": "!OGEhHVWSdvArJzumhm:matrix.org",
+         "stream_ordering": 8326
+      },
+      {
+         "room_id": "!xYvNcQPhnkrdUmYczI:matrix.org",
+         "stream_ordering": 93534
+      }
+   ],
+   "total": 2
+}
+
    +

    To paginate, check for next_token and if present, call the endpoint again +with from set to the value of next_token. This will return a new page.

    +

    If the endpoint does not return a next_token then there are no more destinations +to paginate through.

    +

    Parameters

    +

    The following parameters should be set in the URL:

    + +

    The following query parameters are available:

    + +

    Response

    +

    The following fields are returned in the JSON response body:

    + +

    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