vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1557 from jestabro/update-http-api-rest

Browse Source 
http-api: T6736: update config commands for dedicated REST API node
This commit is contained in:
Robert Göhler 2024-10-07 16:11:52 +02:00 committed by GitHub
commit 1bbe5de12c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/configuration/service/https.rst
View File

@ -67,19 +67,22 @@ API
Set a named api key. Every key has the same, full permissions Set a named api key. Every key has the same, full permissions
on the system. 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 To enable debug messages. Available via :opcmd:`show log` or
:opcmd:`monitor log` :opcmd:`monitor log`
.. cfgcmd:: set service https api strict .. cfgcmd:: set service https api rest strict
Enforce strict path checking. Enforce strict path checking.
.. cfgcmd:: set service https api cors allow-origin <origin>
Allow cross-origin requests from `<origin>`.
GraphQL GraphQL
======= =======
@ -105,12 +108,17 @@ GraphQL
Set the byte length of the JWT secret. Default is 32. 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 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 .. code-block:: none
set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY
set service https api rest