Page MenuHomeVyOS Platform
Create Task
Maniphest T9090

vyos-api docs: clarify that save works on /config-file, not /configure
Open, LowPublic
Actions

Description

Doc page: https://docs.vyos.io/en/latest/automation/vyos-api.html

{"op":"save"} POSTed to /configure returns HTTP 400 — "Malformed command … missing 'path' field". Persisting the config requires POSTing {"op":"save"} to /config-file instead.

The docs do document save under /config-file, but nothing on the /configure section warns that it rejects save — and since all set/delete traffic already flows through /configure, sending the save there is the natural (wrong) first attempt for API users. We hit this in automation on VyOS 1.5 rolling.

Suggested one-line doc addition to the /configure section: "Persistence: to save the running config to disk, use /config-file with {"op":"save"} — /configure does not accept the save op."

Details

Version
docs.vyos.io latest (observed on VyOS 1.5 rolling)
Is it a breaking change?
Perfectly compatible
Issue type
Documentation update

Related Objects

Event Timeline

bradkollmyer created this task.Jul 14 2026, 8:41 PM
bradkollmyer created this object in space S1 VyOS Public.
pasik subscribed.Jul 14 2026, 9:22 PM
eli-sterling subscribed.Wed, Sep 30, 5:35 PM

Verification update: the current rolling API guide now warns in the /configure section that this endpoint does not accept {"op":"save"} and directs users to /config-file: https://github.com/vyos/vyos-documentation/blob/rolling/docs/automation/vyos-api.md#configure. This guidance is present in commit f002549a5fe3ae782be8fe02160fa2796e7e0471 (https://github.com/vyos/vyos-documentation/commit/f002549a5fe3ae782be8fe02160fa2796e7e0471), dated July 14, 2026, titled "vyos-api: T9090: T9091: batched /configure semantics; save via /config-file". This appears to address T9090. Suggested status: move from Open / Need Triage to Resolved, if the reporter or maintainer confirms.