diff options
| author | John Estabrook <jestabro@vyos.io> | 2020-04-08 08:29:37 -0500 |
|---|---|---|
| committer | John Estabrook <jestabro@vyos.io> | 2020-04-08 08:29:37 -0500 |
| commit | ca7bca5a8b65ba415c3154f9ba06a143ba52533b (patch) | |
| tree | 6359cbd9956beb25ac892838d16718dba6507767 /docs | |
| parent | 6efadce3f987598e06208ed898e10c11fe8d7c52 (diff) | |
| download | vyos-documentation-ca7bca5a8b65ba415c3154f9ba06a143ba52533b.tar.gz vyos-documentation-ca7bca5a8b65ba415c3154f9ba06a143ba52533b.zip | |
http api: T2160: update syntax for api-restrict
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/appendix/http-api.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/appendix/http-api.rst b/docs/appendix/http-api.rst index 731ca072..827bcd9e 100644 --- a/docs/appendix/http-api.rst +++ b/docs/appendix/http-api.rst @@ -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 defining a ``service https virtual-host <id>``, and setting ``service https -api virtual-host <id>``. +api-restrict virtual-host <id>``. .. 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 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 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 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 -------------------- |