diff options
| author | Daniil Baturin <daniil@vyos.io> | 2026-05-06 14:09:07 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-06 14:09:07 +0100 |
| commit | e066bb43eab070c58043f69efe87191b354b01e5 (patch) | |
| tree | a390c8fddb08a163feef6710818c10ffdc553733 /docs/configuration/service/md-https.md | |
| parent | 22e34ce5aee24d2fd11f8205522ab7ecdb3c4c5e (diff) | |
| download | vyos-documentation-e066bb43eab070c58043f69efe87191b354b01e5.tar.gz vyos-documentation-e066bb43eab070c58043f69efe87191b354b01e5.zip | |
Revert "Add incremental RST-to-MyST swap mechanism (sagitta) (#1868)" (#1894)
This reverts commit 22e34ce5aee24d2fd11f8205522ab7ecdb3c4c5e.
Diffstat (limited to 'docs/configuration/service/md-https.md')
| -rw-r--r-- | docs/configuration/service/md-https.md | 122 |
1 files changed, 0 insertions, 122 deletions
diff --git a/docs/configuration/service/md-https.md b/docs/configuration/service/md-https.md deleted file mode 100644 index e68bcd50..00000000 --- a/docs/configuration/service/md-https.md +++ /dev/null @@ -1,122 +0,0 @@ -# HTTP API - -VyOS provide an HTTP API. You can use it to execute op-mode commands, -update VyOS, set or delete config. - -Please take a look at the `vyosapi` page for an detailed how-to. - -## Configuration - -<div class="cfgcmd"> - -set service https allow-client address \<address\> - -Only allow certain IP addresses or prefixes to access the https -webserver. - -</div> - -<div class="cfgcmd"> - -set service https certificates ca-certificate \<name\> - -Use CA certificate from PKI subsystem - -</div> - -<div class="cfgcmd"> - -set service https certificates certificate \<name\> - -Use certificate from PKI subsystem - -</div> - -<div class="cfgcmd"> - -set service https certificates dh-params \<name\> - -Use `DH (Diffie–Hellman)` parameters from PKI subsystem. -Must be at least 2048 bits in length. - -</div> - -<div class="cfgcmd"> - -set service https listen-address \<address\> - -Webserver should only listen on specified IP address - -</div> - -<div class="cfgcmd"> - -set service https port \<number\> - -Webserver should listen on specified port. - -Default: 443 - -</div> - -<div class="cfgcmd"> - -set service https enable-http-redirect - -Enable automatic redirect from http to https. - -</div> - -<div class="cfgcmd"> - -set service https tls-version \<1.2 | 1.3\> - -Select TLS version used. - -This defaults to both 1.2 and 1.3. - -</div> - -<div class="cfgcmd"> - -set service https vrf \<name\> - -Start Webserver in given VRF. - -</div> - -### API - -<div class="cfgcmd"> - -set service https api keys id \<name\> key \<apikey\> - -Set a named api key. Every key has the same, full permissions -on the system. - -</div> - -<div class="cfgcmd"> - -set service https api debug - -To enable debug messages. Available via `show log` or -`monitor log` - -</div> - -<div class="cfgcmd"> - -set service https api strict - -Enforce strict path checking - -</div> - -## Example Configuration - -Set an API-KEY is the minimal configuration to get a working API Endpoint. - -``` none -set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY -``` |