Skip to content

Commit

Permalink
Merge pull request #1557 from jestabro/update-http-api-rest
Browse files Browse the repository at this point in the history
http-api: T6736: update config commands for dedicated REST API node
  • Loading branch information
rebortg authored Oct 7, 2024
2 parents fa37004 + f365fda commit 1bbe5de
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions docs/configuration/service/https.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=======

Expand All @@ -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

0 comments on commit 1bbe5de

Please sign in to comment.