T9354: document "reconnect interface" operational commandT9354

PPPoE, SSTP client and WWAN interfaces can now be restarted with a single
command which survives the loss of the CLI session, so it can be issued over
the very interface being reconnected. The WWAN page gained the connect and
disconnect commands as well - they have always been available there, but were
only documented for PPPoE and SSTP.

The command is also exposed by the HTTP API through a dedicated endpoint,
which replaces the "reset connection" path that was previously used for this.

1 files changed, 19 insertions, 0 deletions

diff --git a/docs/automation/vyos-api.md b/docs/automation/vyos-api.md
index 224107f5..19524d7f 100644
--- a/docs/automation/vyos-api.md
+++ b/docs/automation/vyos-api.md
@@ -306,6 +306,25 @@ response:
 ```
 
 
+### /reconnect
+
+The `/reconnect` endpoint runs the `reconnect` command, which brings a
+connection-oriented interface such as PPPoE or WWAN down and up again.
+
+```none
+curl --location --request POST 'https://vyos/reconnect' \
+--form data='{"op": "reconnect", "path": ["interface", "pppoe0"]}' \
+--form key='MY-HTTPS-API-PLAINTEXT-KEY'
+
+response:
+{
+  "success": true,
+  "data": "",
+  "error": null
+}
+```
+
+
 ### /reboot
 
 To initiate a reboot, use the `/reboot` endpoint.