diff options
author | Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> | 2022-01-25 13:06:29 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-01-25 12:06:29 +0000 |
commit | 0d6cfea9b867a14fa0fa885b04c8cbfdb4a7c4a9 (patch) | |
tree | 87d0f98fc221f55e894d516fe41c766b443480a0 /docs/usage | |
parent | Ignore the jsonschema type. (#11817) (diff) | |
download | synapse-0d6cfea9b867a14fa0fa885b04c8cbfdb4a7c4a9.tar.xz |
Add admin API to reset connection timeouts for remote server (#11639)
* Fix get federation status of destination if no error occured
Diffstat (limited to 'docs/usage')
-rw-r--r-- | docs/usage/administration/admin_api/federation.md | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/docs/usage/administration/admin_api/federation.md b/docs/usage/administration/admin_api/federation.md index 8f9535f57b..5e609561a6 100644 --- a/docs/usage/administration/admin_api/federation.md +++ b/docs/usage/administration/admin_api/federation.md @@ -86,7 +86,7 @@ The following fields are returned in the JSON response body: - `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. @@ -108,7 +108,45 @@ A response body like the following is returned: } ``` +**Parameters** + +The following parameters should be set in the URL: + +- `destination` - Name of the remote server. + **Response** The response fields are the same like in the `destinations` array in [List of destinations](#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](https://en.wikipedia.org/wiki/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](#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: + +- `destination` - Name of the remote server. |