mirror of
https://github.com/element-hq/synapse
synced 2024-07-15 10:34:05 +00:00
deploy: 6a72c910f1
This commit is contained in:
DMRobertson
parent
e97a7a34da
commit
63bc2460d9
|
|
@ -12311,6 +12311,57 @@ to this destination, or <code>null</code> if this information has not been track
|
|||
<p><strong>Response</strong></p>
|
||||
<p>The response fields are the same like in the <code>destinations</code> array in
|
||||
<a href="usage/administration/admin_api/federation.html#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="usage/administration/admin_api/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
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -280,6 +280,57 @@ to this destination, or <code>null</code> if this information has not been track
|
|||
<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
|
||||
|
|
|
|||
Loading…
Reference in a new issue