vyos-documentation.git/docs/automation/vyos-api.md, branch secure-boot-updates

T9354: document "reconnect interface" operational command

2026-09-25T19:15:00+00:00

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.

vyos-api: clarify comment regarding commit failure and partial commits (#2178)

2026-08-03T13:21:55+00:00

vyos-api: T9087: T9092: apply review feedback (line length, retry safety)

2026-07-14T21:08:40+00:00

Convert the multi-field-node table to wrapped list items per the 80-char docs guideline, and rework the bulk-apply bullet to reconcile state before retrying after a timeout instead of recommending blind retries. Co-Authored-By: Claude Fable 5

vyos-api: T9087: tighten firewall same-request wording (review feedback)

2026-07-14T21:00:18+00:00

Only port/port-group require protocol in the same request; description alone is fine on an existing rule but fails on a rule no request has created yet. Co-Authored-By: Claude Fable 5

vyos-api: T9092: add bulk configuration guidance

2026-07-14T20:50:41+00:00

Batch sizing, geoip/remote-group commit cost, the 1 MB request-body-size-limit, and commit-confirm as a remote safety net. Co-Authored-By: Claude Fable 5

vyos-api: T9090: T9091: batched /configure semantics; save via /config-file

2026-07-14T20:50:15+00:00

Document that an operation list commits as one transaction whose error may not identify the failing op (bisect / one-op fallback), and that /configure rejects {"op": "save"} — persistence goes through /config-file. Co-Authored-By: Claude Fable 5

vyos-api: T9089: document /retrieve showConfig on empty paths

2026-07-14T20:49:48+00:00

showConfig returns HTTP 400 'Configuration under specified path is empty' for schema-valid but unconfigured paths; recommend probing with exists or treating that error as an empty subtree. Co-Authored-By: Claude Fable 5

vyos-api: T9088: document /show configuration commands export

2026-07-14T20:49:22+00:00

The /show endpoint can return the running config as flat set commands (op-mode 'show configuration commands' equivalent) — the natural way to mirror or back up a router over the API; previously undocumented. Co-Authored-By: Claude Fable 5

vyos-api: T9087: document commit atomicity for multi-field nodes

2026-07-14T20:48:59+00:00

Each /configure request is validated and committed on its own, so fields of one node (task-scheduler executable+interval, NAT translation, firewall action/protocol before port) must be sent in a single request. Co-Authored-By: Claude Fable 5

feat: flip swap mechanism — MD as primary, RST as override (Phase 1)

2026-05-06T17:42:32+00:00

This is the first of three phases inverting the per-page swap mechanism so MD becomes the canonical primary and RST becomes the rare override. Phase 1 — file renames + conf.py exclude_patterns flip only: - Rename docs/**/md-.md to docs/**/.md (drop md- prefix) for all 254 stems previously listed in docs/_swap.txt - Rename docs/**/.rst to docs/**/rst-.rst (add rst- prefix) for the same 254 stems - Repurpose docs/_swap.txt as docs/_rst_overrides.txt; initially empty comment-only since no pages need the RST fallback right now - conf.py exclude_patterns flipped: rst-*.rst is now excluded by default instead of md-*.md - conf.py runtime-artifact references updated to _rst_override_state.json and _md_exclude.txt (Phase 2 will rewrite swap_sources.py to produce these names; for now no swap script runs because overrides list is empty) Phase 2 (next commit on this branch) will rewrite scripts/swap_sources.py with inverted rename direction, delete scripts/import_myst.py + tests, and update tests/test_swap_sources.py for the new semantics. Phase 3 will be the cleanup pass and ready-for-review flip. Generated by robots https://vyos.io