diff options
| author | Brad Kollmyer <bradk@vitalsoft.com> | 2026-07-14 13:50:15 -0700 |
|---|---|---|
| committer | Brad Kollmyer <bradk@vitalsoft.com> | 2026-07-14 13:50:15 -0700 |
| commit | f002549a5fe3ae782be8fe02160fa2796e7e0471 (patch) | |
| tree | d0b852ca72c4b70014db9dd5ffe6e29620524704 /docs | |
| parent | 3a952350bf5b5b38a7db1208ed3c910ded7b4b24 (diff) | |
| download | vyos-documentation-f002549a5fe3ae782be8fe02160fa2796e7e0471.tar.gz vyos-documentation-f002549a5fe3ae782be8fe02160fa2796e7e0471.zip | |
vyos-api: T9090: T9091: batched /configure semantics; save via /config-file
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 <noreply@anthropic.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/automation/vyos-api.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/automation/vyos-api.md b/docs/automation/vyos-api.md index c7f30842..3c3d16f3 100644 --- a/docs/automation/vyos-api.md +++ b/docs/automation/vyos-api.md @@ -513,6 +513,19 @@ response: } ``` +A list of operations is applied and committed as a single transaction: if +any operation fails, nothing is committed. The error message may not +identify which operation in the list failed, so if a large list fails +validation, retry the operations in smaller lists (or one per request) to +locate the offending one. + +:::{note} +The `/configure` endpoint commits changes to the running configuration but +does not save them to disk, and it does not accept `{"op": "save"}` (that +returns HTTP 400). To persist changes across reboots, send +`{"op": "save"}` to the `/config-file` endpoint. +::: + ### /config-file |