blob: e68bcd500e1bb7874cfc01d103b61f8062f5d650 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
# HTTP API
VyOS provide an HTTP API. You can use it to execute op-mode commands,
update VyOS, set or delete config.
Please take a look at the `vyosapi` page for an detailed how-to.
## Configuration
<div class="cfgcmd">
set service https allow-client address \<address\>
Only allow certain IP addresses or prefixes to access the https
webserver.
</div>
<div class="cfgcmd">
set service https certificates ca-certificate \<name\>
Use CA certificate from PKI subsystem
</div>
<div class="cfgcmd">
set service https certificates certificate \<name\>
Use certificate from PKI subsystem
</div>
<div class="cfgcmd">
set service https certificates dh-params \<name\>
Use `DH (Diffie–Hellman)` parameters from PKI subsystem.
Must be at least 2048 bits in length.
</div>
<div class="cfgcmd">
set service https listen-address \<address\>
Webserver should only listen on specified IP address
</div>
<div class="cfgcmd">
set service https port \<number\>
Webserver should listen on specified port.
Default: 443
</div>
<div class="cfgcmd">
set service https enable-http-redirect
Enable automatic redirect from http to https.
</div>
<div class="cfgcmd">
set service https tls-version \<1.2 | 1.3\>
Select TLS version used.
This defaults to both 1.2 and 1.3.
</div>
<div class="cfgcmd">
set service https vrf \<name\>
Start Webserver in given VRF.
</div>
### API
<div class="cfgcmd">
set service https api keys id \<name\> key \<apikey\>
Set a named api key. Every key has the same, full permissions
on the system.
</div>
<div class="cfgcmd">
set service https api debug
To enable debug messages. Available via `show log` or
`monitor log`
</div>
<div class="cfgcmd">
set service https api strict
Enforce strict path checking
</div>
## Example Configuration
Set an API-KEY is the minimal configuration to get a working API Endpoint.
``` none
set service https api keys id MY-HTTPS-API-ID key MY-HTTPS-API-PLAINTEXT-KEY
```
|
