diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-10 18:14:42 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-05-10 18:14:42 +0300 |
| commit | 0c0c93f4e1679c12c11006875b594e57a7b8a317 (patch) | |
| tree | 0de13ab1a9ae1504ef1c46192b060363da69978c /docs/configuration/service/rst-https.rst | |
| parent | 15855844e1fe5b0bd39b020639f4c08c69d24864 (diff) | |
| parent | e4b5ca7d2dae8a2d89fdfb0f55a67319bf6b35cc (diff) | |
| download | vyos-documentation-0c0c93f4e1679c12c11006875b594e57a7b8a317.tar.gz vyos-documentation-0c0c93f4e1679c12c11006875b594e57a7b8a317.zip | |
Merge pull request #1942 from vyos/yuriy/remove-rst-swap-mechanism-sagitta
chore: remove RST swap mechanism, archive rst-*.rst under docs/_rst_legacy/ (sagitta)
Diffstat (limited to 'docs/configuration/service/rst-https.rst')
| -rw-r--r-- | docs/configuration/service/rst-https.rst | 83 |
1 files changed, 0 insertions, 83 deletions
diff --git a/docs/configuration/service/rst-https.rst b/docs/configuration/service/rst-https.rst deleted file mode 100644 index 973c5355..00000000 --- a/docs/configuration/service/rst-https.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. _http-api: - -######## -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 :ref:`vyosapi` page for an detailed how-to. - -************* -Configuration -************* - -.. cfgcmd:: set service https allow-client address <address> - - Only allow certain IP addresses or prefixes to access the https - webserver. - -.. cfgcmd:: set service https certificates ca-certificate <name> - - Use CA certificate from PKI subsystem - -.. cfgcmd:: set service https certificates certificate <name> - - Use certificate from PKI subsystem - -.. cfgcmd:: set service https certificates dh-params <name> - - Use :abbr:`DH (Diffie–Hellman)` parameters from PKI subsystem. - Must be at least 2048 bits in length. - -.. cfgcmd:: set service https listen-address <address> - - Webserver should only listen on specified IP address - -.. cfgcmd:: set service https port <number> - - Webserver should listen on specified port. - - Default: 443 - -.. cfgcmd:: set service https enable-http-redirect - - Enable automatic redirect from http to https. - -.. cfgcmd:: set service https tls-version <1.2 | 1.3> - - Select TLS version used. - - This defaults to both 1.2 and 1.3. - -.. cfgcmd:: set service https vrf <name> - - Start Webserver in given VRF. - -API -=== - -.. 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. - -.. cfgcmd:: set service https api debug - - To enable debug messages. Available via :opcmd:`show log` or - :opcmd:`monitor log` - -.. cfgcmd:: set service https api strict - - Enforce strict path checking - -********************* -Example Configuration -********************* - -Set an API-KEY is the minimal configuration to get a working API Endpoint. - -.. code-block:: none - - set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY |