vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-11-02 20:02:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

http api: T2160: update syntax for api-restrict

Browse Source
This commit is contained in:
John Estabrook 2020-04-08 08:29:37 -05:00
parent 6efadce3f9
commit ca7bca5a8b
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/appendix/http-api.rst
View File

@ -20,7 +20,7 @@ assume nginx is running at https://192.168.122.127.
One can limit proxying to specific listen addresses/ports/server-names by One can limit proxying to specific listen addresses/ports/server-names by
defining a ``service https virtual-host <id>``, and setting ``service https defining a ``service https virtual-host <id>``, and setting ``service https
api virtual-host <id>``. api-restrict virtual-host <id>``.
.. code-block:: none .. code-block:: none
@ -28,13 +28,13 @@ api virtual-host <id>``.
set service https virtual-host example listen-port 44302 set service https virtual-host example listen-port 44302
set service https virtual-host example server-name example.net set service https virtual-host example server-name example.net
set service https api virtual-host example set service https api-restrict virtual-host example
In this example, nginx will proxy only those requests to In this example, nginx will proxy only those requests to
192.168.122.127:44302 or example.net:44302 (assuming the DNS record is 192.168.122.127:44302 or example.net:44302 (assuming the DNS record is
viable). Omitting any of listen-address, listen-port, or server-name, will viable). Omitting any of listen-address, listen-port, or server-name, will
leave appropriate defaults in the nginx directive. Multiple instances of leave appropriate defaults in the nginx directive. Multiple instances of
``service https api virtual-host`` may be set. ``service https api-restrict virtual-host`` may be set.
Operational requests Operational requests
-------------------- --------------------