Page MenuHomeVyOS Platform

vyos-api docs: document /show with path ["configuration","commands"] (set-command export)
Open, LowPublic

Description

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

The /show endpoint section only demonstrates {"op":"show","path":["system","image"]}. This works and is extremely useful, but is undocumented:

curl -k --location --request POST https://<router>/show \
  --form key='<apikey>' \
  --form data='{"op": "show", "path": ["configuration", "commands"]}'

It returns the full running configuration as flat set commands — the natural way to mirror, diff, or back up a router over the API (equivalent of op-mode show configuration commands). We use it as the primary workflow for keeping per-router config mirrors in git, verified stable on VyOS 1.5 rolling across four routers.

Suggest adding it as a first-class example on the API page next to the ["system","image"] one (and ["configuration","json"] if that is also considered a supported path).

Details

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

Event Timeline

@bradkollmyer Hi! For the documentation, you can add PRs without a phorge task. Thanks,