Skip to content

fix(rest): update /rest/system/connections docs to match status quo #958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marbens-arch merged 2 commits into from
Sep 1, 2025
Merged

fix(rest): update /rest/system/connections docs to match status quo #958

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd0baff
fix(system-connections-get): update for syncthing/syncthing#3771 and …
marbens-arch Sep 1, 2025
07864d7
Update for syncthing/syncthing#5737
marbens-arch Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions rest/system-connections-get.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ GET /rest/system/connections
============================


.. note:: Return format changed in versions 0.13.0, 1.19.0 and 1.23.0.
.. note:: Return format changed in versions 0.13.0, 0.14.14, 1.2.0, 1.19.0, 1.23.0 and 1.25.0.


Returns the list of configured devices and some metadata associated
with them. The list also contains the local device itself as not connected.
with them.

The connection types are ``TCP (Client)``, ``TCP (Server)``, ``Relay (Client)`` and ``Relay (Server)``.
The connection types are ``tcp-client``, ``tcp-server``, ``relay-client``, ``relay-server``, ``quic-client`` and ``quic-server``.

.. code-block:: json

Expand Down Expand Up @@ -48,7 +48,7 @@ The connection types are ``TCP (Client)``, ``TCP (Server)``, ``Relay (Client)``
"outBytesTotal": 550,
"paused": false,
"startedAt": "2015-11-07T00:09:47Z",
"type": "TCP (Client)"
"type": "tcp-client"
}
},
"total": {
Expand Down