VyOS provides an HTTP API. You can use it to execute op-mode commands, update VyOS, set or delete config.
Please take a look at the VyOS API page for an detailed how-to.
Set a named api key, every key has the same, full permissions on the system.
Set the listen port of the local API, this has no effect on the webserver. The default is port 8080
Port to listen for HTTPS requests; default 443
Server names for virtual hosts it ca be exact, wildcard or regex.
Nginx exposes the local API on all virtual servers, by default. Use this to restrict nginx to one or more virtual hosts.
Domain name(s) for which to obtain certificate
Use an automatically generated self-signed certificate
Setting an API-KEY is the minimal configuration needed to get a working API Endpoint.
set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY
To use this full configuration we asume a globally resolvable hostname.
set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY set service https certificates certbot domain-name rtr01.example.com set service https certificates certbot email [email protected] set service https virtual-host rtr01 listen-address 198.51.100.2 set service https virtual-host rtr01 listen-port 11443 set service https virtual-host rtr01 server-name rtr01.example.com set service https api-restrict virtual-host rtr01