summaryrefslogtreecommitdiff
path: root/docs/configuration/service
diff options
context:
space:
mode:
authorJohn Estabrook <jestabro@vyos.io>2024-10-01 12:14:55 -0500
committerJohn Estabrook <jestabro@vyos.io>2024-10-01 12:16:16 -0500
commitf365fdad30cebef24cf0ff09c0be581c26918f43 (patch)
tree054d201806c33563185554b4a955c2650362031b /docs/configuration/service
parentfa370043b5f639090577ec827577297a184599b2 (diff)
downloadvyos-documentation-f365fdad30cebef24cf0ff09c0be581c26918f43.tar.gz
vyos-documentation-f365fdad30cebef24cf0ff09c0be581c26918f43.zip
http-api: T6736: update config commands for dedicated REST API node
Diffstat (limited to 'docs/configuration/service')
-rw-r--r--docs/configuration/service/https.rst22
1 files changed, 15 insertions, 7 deletions
diff --git a/docs/configuration/service/https.rst b/docs/configuration/service/https.rst
index af397456..e72e8e8b 100644
--- a/docs/configuration/service/https.rst
+++ b/docs/configuration/service/https.rst
@@ -67,19 +67,22 @@ API
Set a named api key. Every key has the same, full permissions
on the system.
-.. cfgcmd:: set service https api debug
+REST
+====
+
+.. cfgcmd:: set service https api rest
+
+ Enable REST API
+
+.. cfgcmd:: set service https api rest debug
To enable debug messages. Available via :opcmd:`show log` or
:opcmd:`monitor log`
-.. cfgcmd:: set service https api strict
+.. cfgcmd:: set service https api rest strict
Enforce strict path checking.
-.. cfgcmd:: set service https api cors allow-origin <origin>
-
- Allow cross-origin requests from `<origin>`.
-
GraphQL
=======
@@ -105,12 +108,17 @@ GraphQL
Set the byte length of the JWT secret. Default is 32.
+.. cfgcmd:: set service https api graphql cors allow-origin <origin>
+
+ Allow cross-origin requests from `<origin>`.
+
*********************
Example Configuration
*********************
-Set an API-KEY is the minimal configuration to get a working API Endpoint.
+Setting REST API and 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
+ set service https api rest