]>
Commit | Line | Data |
---|---|---|
410dc2c9 DM |
1 | var pmgapi = [ |
2 | { | |
3 | "children" : [ | |
4 | { | |
5 | "children" : [ | |
6 | { | |
7 | "info" : { | |
8 | "GET" : { | |
9 | "description" : "Get list of rules.", | |
10 | "method" : "GET", | |
11 | "name" : "list_rules", | |
12 | "parameters" : { | |
13 | "additionalProperties" : 0 | |
14 | }, | |
15 | "protected" : 1, | |
16 | "proxyto" : "master", | |
17 | "returns" : { | |
18 | "items" : { | |
eff914dc DM |
19 | "properties" : { |
20 | "id" : { | |
21 | "type" : "integer" | |
22 | } | |
23 | }, | |
410dc2c9 DM |
24 | "type" : "object" |
25 | }, | |
eff914dc DM |
26 | "links" : [ |
27 | { | |
28 | "href" : "{id}", | |
29 | "rel" : "child" | |
30 | } | |
31 | ], | |
410dc2c9 DM |
32 | "type" : "array" |
33 | } | |
34 | } | |
35 | }, | |
36 | "leaf" : 1, | |
37 | "path" : "/config/ruledb/rules", | |
38 | "text" : "rules" | |
39 | }, | |
40 | { | |
41 | "info" : { | |
42 | "GET" : { | |
eff914dc | 43 | "description" : "Get list of 'action' groups.", |
410dc2c9 | 44 | "method" : "GET", |
eff914dc | 45 | "name" : "list_action_groups", |
410dc2c9 DM |
46 | "parameters" : { |
47 | "additionalProperties" : 0 | |
48 | }, | |
49 | "protected" : 1, | |
50 | "proxyto" : "master", | |
51 | "returns" : { | |
52 | "items" : { | |
eff914dc DM |
53 | "properties" : { |
54 | "id" : { | |
55 | "type" : "integer" | |
56 | } | |
57 | }, | |
410dc2c9 DM |
58 | "type" : "object" |
59 | }, | |
60 | "type" : "array" | |
61 | } | |
eff914dc DM |
62 | }, |
63 | "POST" : { | |
64 | "description" : "Create a new 'action' group.", | |
65 | "method" : "POST", | |
66 | "name" : "create_action_group", | |
67 | "parameters" : { | |
68 | "additionalProperties" : 0, | |
69 | "properties" : { | |
70 | "info" : { | |
71 | "description" : "Informational comment.", | |
72 | "maxLength" : 255, | |
73 | "optional" : 1, | |
74 | "type" : "string", | |
75 | "typetext" : "<string>" | |
76 | }, | |
77 | "name" : { | |
78 | "description" : "Group name.", | |
79 | "maxLength" : 255, | |
80 | "type" : "string", | |
81 | "typetext" : "<string>" | |
82 | } | |
83 | } | |
84 | }, | |
85 | "protected" : 1, | |
86 | "proxyto" : "master", | |
87 | "returns" : { | |
88 | "type" : "integer" | |
89 | } | |
410dc2c9 DM |
90 | } |
91 | }, | |
92 | "leaf" : 1, | |
eff914dc DM |
93 | "path" : "/config/ruledb/action", |
94 | "text" : "action" | |
410dc2c9 DM |
95 | }, |
96 | { | |
97 | "info" : { | |
98 | "GET" : { | |
eff914dc | 99 | "description" : "Get list of 'what' groups.", |
410dc2c9 | 100 | "method" : "GET", |
eff914dc | 101 | "name" : "list_what_groups", |
410dc2c9 DM |
102 | "parameters" : { |
103 | "additionalProperties" : 0 | |
104 | }, | |
105 | "protected" : 1, | |
106 | "proxyto" : "master", | |
107 | "returns" : { | |
108 | "items" : { | |
eff914dc DM |
109 | "properties" : { |
110 | "id" : { | |
111 | "type" : "integer" | |
112 | } | |
113 | }, | |
410dc2c9 DM |
114 | "type" : "object" |
115 | }, | |
116 | "type" : "array" | |
117 | } | |
eff914dc DM |
118 | }, |
119 | "POST" : { | |
120 | "description" : "Create a new 'what' group.", | |
121 | "method" : "POST", | |
122 | "name" : "create_what_group", | |
123 | "parameters" : { | |
124 | "additionalProperties" : 0, | |
125 | "properties" : { | |
126 | "info" : { | |
127 | "description" : "Informational comment.", | |
128 | "maxLength" : 255, | |
129 | "optional" : 1, | |
130 | "type" : "string", | |
131 | "typetext" : "<string>" | |
132 | }, | |
133 | "name" : { | |
134 | "description" : "Group name.", | |
135 | "maxLength" : 255, | |
136 | "type" : "string", | |
137 | "typetext" : "<string>" | |
138 | } | |
139 | } | |
140 | }, | |
141 | "protected" : 1, | |
142 | "proxyto" : "master", | |
143 | "returns" : { | |
144 | "type" : "integer" | |
145 | } | |
410dc2c9 DM |
146 | } |
147 | }, | |
148 | "leaf" : 1, | |
149 | "path" : "/config/ruledb/what", | |
150 | "text" : "what" | |
151 | }, | |
152 | { | |
153 | "info" : { | |
154 | "GET" : { | |
eff914dc | 155 | "description" : "Get list of 'when' groups.", |
410dc2c9 | 156 | "method" : "GET", |
eff914dc | 157 | "name" : "list_when_groups", |
410dc2c9 DM |
158 | "parameters" : { |
159 | "additionalProperties" : 0 | |
160 | }, | |
161 | "protected" : 1, | |
162 | "proxyto" : "master", | |
163 | "returns" : { | |
164 | "items" : { | |
eff914dc DM |
165 | "properties" : { |
166 | "id" : { | |
167 | "type" : "integer" | |
168 | } | |
169 | }, | |
410dc2c9 DM |
170 | "type" : "object" |
171 | }, | |
172 | "type" : "array" | |
173 | } | |
eff914dc DM |
174 | }, |
175 | "POST" : { | |
176 | "description" : "Create a new 'when' group.", | |
177 | "method" : "POST", | |
178 | "name" : "create_when_group", | |
179 | "parameters" : { | |
180 | "additionalProperties" : 0, | |
181 | "properties" : { | |
182 | "info" : { | |
183 | "description" : "Informational comment.", | |
184 | "maxLength" : 255, | |
185 | "optional" : 1, | |
186 | "type" : "string", | |
187 | "typetext" : "<string>" | |
188 | }, | |
189 | "name" : { | |
190 | "description" : "Group name.", | |
191 | "maxLength" : 255, | |
192 | "type" : "string", | |
193 | "typetext" : "<string>" | |
194 | } | |
195 | } | |
196 | }, | |
197 | "protected" : 1, | |
198 | "proxyto" : "master", | |
199 | "returns" : { | |
200 | "type" : "integer" | |
201 | } | |
410dc2c9 DM |
202 | } |
203 | }, | |
204 | "leaf" : 1, | |
205 | "path" : "/config/ruledb/when", | |
206 | "text" : "when" | |
207 | }, | |
208 | { | |
eff914dc DM |
209 | "children" : [ |
210 | { | |
211 | "children" : [ | |
212 | { | |
213 | "children" : [ | |
214 | { | |
215 | "info" : { | |
216 | "DELETE" : { | |
217 | "description" : "Remove an object from the group.", | |
218 | "method" : "DELETE", | |
219 | "name" : "delete_object", | |
220 | "parameters" : { | |
221 | "additionalProperties" : 0, | |
222 | "properties" : { | |
223 | "id" : { | |
224 | "description" : "Object ID.", | |
225 | "type" : "integer", | |
226 | "typetext" : "<integer>" | |
227 | }, | |
228 | "ogroup" : { | |
229 | "description" : "Object Group ID.", | |
230 | "type" : "integer", | |
231 | "typetext" : "<integer>" | |
232 | } | |
233 | } | |
234 | }, | |
235 | "proxyto" : "master", | |
236 | "returns" : { | |
237 | "type" : "null" | |
238 | } | |
239 | } | |
240 | }, | |
241 | "leaf" : 1, | |
242 | "path" : "/config/ruledb/who/{ogroup}/objects/{id}", | |
243 | "text" : "{id}" | |
244 | } | |
245 | ], | |
246 | "info" : { | |
247 | "GET" : { | |
248 | "description" : "List group objects.", | |
249 | "method" : "GET", | |
250 | "name" : "objects", | |
251 | "parameters" : { | |
252 | "additionalProperties" : 0, | |
253 | "properties" : { | |
254 | "ogroup" : { | |
255 | "description" : "Object Group ID.", | |
256 | "type" : "integer", | |
257 | "typetext" : "<integer>" | |
258 | } | |
259 | } | |
260 | }, | |
261 | "proxyto" : "master", | |
262 | "returns" : { | |
263 | "items" : { | |
264 | "properties" : { | |
265 | "id" : { | |
266 | "type" : "integer" | |
267 | } | |
268 | }, | |
269 | "type" : "object" | |
270 | }, | |
271 | "links" : [ | |
272 | { | |
273 | "href" : "{id}", | |
274 | "rel" : "child" | |
275 | } | |
276 | ], | |
277 | "type" : "array" | |
278 | } | |
279 | } | |
280 | }, | |
281 | "leaf" : 0, | |
282 | "path" : "/config/ruledb/who/{ogroup}/objects", | |
283 | "text" : "objects" | |
284 | }, | |
285 | { | |
286 | "children" : [ | |
287 | { | |
288 | "info" : { | |
289 | "GET" : { | |
290 | "description" : "Read 'Mail address' object settings.", | |
291 | "method" : "GET", | |
292 | "name" : "read_email", | |
293 | "parameters" : { | |
294 | "additionalProperties" : 0, | |
295 | "properties" : { | |
296 | "id" : { | |
297 | "description" : "Object ID.", | |
298 | "type" : "integer", | |
299 | "typetext" : "<integer>" | |
300 | }, | |
301 | "ogroup" : { | |
302 | "description" : "Object Groups ID.", | |
303 | "type" : "integer", | |
304 | "typetext" : "<integer>" | |
305 | } | |
306 | } | |
307 | }, | |
308 | "proxyto" : "master", | |
309 | "returns" : { | |
310 | "properties" : { | |
311 | "id" : { | |
312 | "type" : "integer" | |
313 | } | |
314 | }, | |
315 | "type" : "object" | |
316 | } | |
317 | }, | |
318 | "PUT" : { | |
319 | "description" : "Update 'Mail address' object.", | |
320 | "method" : "PUT", | |
321 | "name" : "update_email", | |
322 | "parameters" : { | |
323 | "additionalProperties" : 0, | |
324 | "properties" : { | |
325 | "email" : { | |
326 | "description" : "Email address.", | |
327 | "format" : "email", | |
328 | "type" : "string", | |
329 | "typetext" : "<string>" | |
330 | }, | |
331 | "id" : { | |
332 | "description" : "Object ID.", | |
333 | "type" : "integer", | |
334 | "typetext" : "<integer>" | |
335 | }, | |
336 | "ogroup" : { | |
337 | "description" : "Object Groups ID.", | |
338 | "type" : "integer", | |
339 | "typetext" : "<integer>" | |
340 | } | |
341 | } | |
342 | }, | |
343 | "proxyto" : "master", | |
344 | "returns" : { | |
345 | "type" : "null" | |
346 | } | |
347 | } | |
348 | }, | |
349 | "leaf" : 1, | |
350 | "path" : "/config/ruledb/who/{ogroup}/email/{id}", | |
351 | "text" : "{id}" | |
352 | } | |
353 | ], | |
354 | "info" : { | |
355 | "POST" : { | |
356 | "description" : "Add 'Mail address' object.", | |
357 | "method" : "POST", | |
358 | "name" : "email", | |
359 | "parameters" : { | |
360 | "additionalProperties" : 0, | |
361 | "properties" : { | |
362 | "email" : { | |
363 | "description" : "Email address.", | |
364 | "format" : "email", | |
365 | "type" : "string", | |
366 | "typetext" : "<string>" | |
367 | }, | |
368 | "ogroup" : { | |
369 | "description" : "Object Groups ID.", | |
370 | "type" : "integer", | |
371 | "typetext" : "<integer>" | |
372 | } | |
373 | } | |
374 | }, | |
375 | "proxyto" : "master", | |
376 | "returns" : { | |
377 | "description" : "The object ID.", | |
378 | "type" : "integer" | |
379 | } | |
380 | } | |
381 | }, | |
382 | "leaf" : 0, | |
383 | "path" : "/config/ruledb/who/{ogroup}/email", | |
384 | "text" : "email" | |
385 | }, | |
386 | { | |
387 | "children" : [ | |
388 | { | |
389 | "info" : { | |
390 | "GET" : { | |
391 | "description" : "Read 'Domain' object settings.", | |
392 | "method" : "GET", | |
393 | "name" : "read_domain", | |
394 | "parameters" : { | |
395 | "additionalProperties" : 0, | |
396 | "properties" : { | |
397 | "id" : { | |
398 | "description" : "Object ID.", | |
399 | "type" : "integer", | |
400 | "typetext" : "<integer>" | |
401 | }, | |
402 | "ogroup" : { | |
403 | "description" : "Object Groups ID.", | |
404 | "type" : "integer", | |
405 | "typetext" : "<integer>" | |
406 | } | |
407 | } | |
408 | }, | |
409 | "proxyto" : "master", | |
410 | "returns" : { | |
411 | "properties" : { | |
412 | "id" : { | |
413 | "type" : "integer" | |
414 | } | |
415 | }, | |
416 | "type" : "object" | |
417 | } | |
418 | }, | |
419 | "PUT" : { | |
420 | "description" : "Update 'Domain' object.", | |
421 | "method" : "PUT", | |
422 | "name" : "update_domain", | |
423 | "parameters" : { | |
424 | "additionalProperties" : 0, | |
425 | "properties" : { | |
426 | "domain" : { | |
427 | "description" : "DNS domain name (Sender).", | |
428 | "format" : "dns-name", | |
429 | "type" : "string", | |
430 | "typetext" : "<string>" | |
431 | }, | |
432 | "id" : { | |
433 | "description" : "Object ID.", | |
434 | "type" : "integer", | |
435 | "typetext" : "<integer>" | |
436 | }, | |
437 | "ogroup" : { | |
438 | "description" : "Object Groups ID.", | |
439 | "type" : "integer", | |
440 | "typetext" : "<integer>" | |
441 | } | |
442 | } | |
443 | }, | |
444 | "proxyto" : "master", | |
445 | "returns" : { | |
446 | "type" : "null" | |
447 | } | |
448 | } | |
449 | }, | |
450 | "leaf" : 1, | |
451 | "path" : "/config/ruledb/who/{ogroup}/domain/{id}", | |
452 | "text" : "{id}" | |
453 | } | |
454 | ], | |
455 | "info" : { | |
456 | "POST" : { | |
457 | "description" : "Add 'Domain' object.", | |
458 | "method" : "POST", | |
459 | "name" : "domain", | |
460 | "parameters" : { | |
461 | "additionalProperties" : 0, | |
462 | "properties" : { | |
463 | "domain" : { | |
464 | "description" : "DNS domain name (Sender).", | |
465 | "format" : "dns-name", | |
466 | "type" : "string", | |
467 | "typetext" : "<string>" | |
468 | }, | |
469 | "ogroup" : { | |
470 | "description" : "Object Groups ID.", | |
471 | "type" : "integer", | |
472 | "typetext" : "<integer>" | |
473 | } | |
474 | } | |
475 | }, | |
476 | "proxyto" : "master", | |
477 | "returns" : { | |
478 | "description" : "The object ID.", | |
479 | "type" : "integer" | |
480 | } | |
481 | } | |
482 | }, | |
483 | "leaf" : 0, | |
484 | "path" : "/config/ruledb/who/{ogroup}/domain", | |
485 | "text" : "domain" | |
486 | }, | |
487 | { | |
488 | "children" : [ | |
489 | { | |
490 | "info" : { | |
491 | "GET" : { | |
492 | "description" : "Read 'Regular Expression' object settings.", | |
493 | "method" : "GET", | |
494 | "name" : "read_regex", | |
495 | "parameters" : { | |
496 | "additionalProperties" : 0, | |
497 | "properties" : { | |
498 | "id" : { | |
499 | "description" : "Object ID.", | |
500 | "type" : "integer", | |
501 | "typetext" : "<integer>" | |
502 | }, | |
503 | "ogroup" : { | |
504 | "description" : "Object Groups ID.", | |
505 | "type" : "integer", | |
506 | "typetext" : "<integer>" | |
507 | } | |
508 | } | |
509 | }, | |
510 | "proxyto" : "master", | |
511 | "returns" : { | |
512 | "properties" : { | |
513 | "id" : { | |
514 | "type" : "integer" | |
515 | } | |
516 | }, | |
517 | "type" : "object" | |
518 | } | |
519 | }, | |
520 | "PUT" : { | |
521 | "description" : "Update 'Regular Expression' object.", | |
522 | "method" : "PUT", | |
523 | "name" : "update_regex", | |
524 | "parameters" : { | |
525 | "additionalProperties" : 0, | |
526 | "properties" : { | |
527 | "id" : { | |
528 | "description" : "Object ID.", | |
529 | "type" : "integer", | |
530 | "typetext" : "<integer>" | |
531 | }, | |
532 | "ogroup" : { | |
533 | "description" : "Object Groups ID.", | |
534 | "type" : "integer", | |
535 | "typetext" : "<integer>" | |
536 | }, | |
537 | "regex" : { | |
538 | "description" : "Email address regular expression.", | |
539 | "maxLength" : 1024, | |
540 | "type" : "string", | |
541 | "typetext" : "<string>" | |
542 | } | |
543 | } | |
544 | }, | |
545 | "proxyto" : "master", | |
546 | "returns" : { | |
547 | "type" : "null" | |
548 | } | |
549 | } | |
550 | }, | |
551 | "leaf" : 1, | |
552 | "path" : "/config/ruledb/who/{ogroup}/regex/{id}", | |
553 | "text" : "{id}" | |
554 | } | |
555 | ], | |
556 | "info" : { | |
557 | "POST" : { | |
558 | "description" : "Add 'Regular Expression' object.", | |
559 | "method" : "POST", | |
560 | "name" : "regex", | |
561 | "parameters" : { | |
562 | "additionalProperties" : 0, | |
563 | "properties" : { | |
564 | "ogroup" : { | |
565 | "description" : "Object Groups ID.", | |
566 | "type" : "integer", | |
567 | "typetext" : "<integer>" | |
568 | }, | |
569 | "regex" : { | |
570 | "description" : "Email address regular expression.", | |
571 | "maxLength" : 1024, | |
572 | "type" : "string", | |
573 | "typetext" : "<string>" | |
574 | } | |
575 | } | |
576 | }, | |
577 | "proxyto" : "master", | |
578 | "returns" : { | |
579 | "description" : "The object ID.", | |
580 | "type" : "integer" | |
581 | } | |
582 | } | |
583 | }, | |
584 | "leaf" : 0, | |
585 | "path" : "/config/ruledb/who/{ogroup}/regex", | |
586 | "text" : "regex" | |
587 | }, | |
588 | { | |
589 | "children" : [ | |
590 | { | |
591 | "info" : { | |
592 | "GET" : { | |
593 | "description" : "Read 'IP Address' object settings.", | |
594 | "method" : "GET", | |
595 | "name" : "read_ip", | |
596 | "parameters" : { | |
597 | "additionalProperties" : 0, | |
598 | "properties" : { | |
599 | "id" : { | |
600 | "description" : "Object ID.", | |
601 | "type" : "integer", | |
602 | "typetext" : "<integer>" | |
603 | }, | |
604 | "ogroup" : { | |
605 | "description" : "Object Groups ID.", | |
606 | "type" : "integer", | |
607 | "typetext" : "<integer>" | |
608 | } | |
609 | } | |
610 | }, | |
611 | "proxyto" : "master", | |
612 | "returns" : { | |
613 | "properties" : { | |
614 | "id" : { | |
615 | "type" : "integer" | |
616 | } | |
617 | }, | |
618 | "type" : "object" | |
619 | } | |
620 | }, | |
621 | "PUT" : { | |
622 | "description" : "Update 'IP Address' object.", | |
623 | "method" : "PUT", | |
624 | "name" : "update_ip", | |
625 | "parameters" : { | |
626 | "additionalProperties" : 0, | |
627 | "properties" : { | |
628 | "id" : { | |
629 | "description" : "Object ID.", | |
630 | "type" : "integer", | |
631 | "typetext" : "<integer>" | |
632 | }, | |
633 | "ip" : { | |
634 | "description" : "IP address", | |
635 | "format" : "ip", | |
636 | "type" : "string", | |
637 | "typetext" : "<string>" | |
638 | }, | |
639 | "ogroup" : { | |
640 | "description" : "Object Groups ID.", | |
641 | "type" : "integer", | |
642 | "typetext" : "<integer>" | |
643 | } | |
644 | } | |
645 | }, | |
646 | "proxyto" : "master", | |
647 | "returns" : { | |
648 | "type" : "null" | |
649 | } | |
650 | } | |
651 | }, | |
652 | "leaf" : 1, | |
653 | "path" : "/config/ruledb/who/{ogroup}/ip/{id}", | |
654 | "text" : "{id}" | |
655 | } | |
656 | ], | |
657 | "info" : { | |
658 | "POST" : { | |
659 | "description" : "Add 'IP Address' object.", | |
660 | "method" : "POST", | |
661 | "name" : "ip", | |
662 | "parameters" : { | |
663 | "additionalProperties" : 0, | |
664 | "properties" : { | |
665 | "ip" : { | |
666 | "description" : "IP address", | |
667 | "format" : "ip", | |
668 | "type" : "string", | |
669 | "typetext" : "<string>" | |
670 | }, | |
671 | "ogroup" : { | |
672 | "description" : "Object Groups ID.", | |
673 | "type" : "integer", | |
674 | "typetext" : "<integer>" | |
675 | } | |
676 | } | |
677 | }, | |
678 | "proxyto" : "master", | |
679 | "returns" : { | |
680 | "description" : "The object ID.", | |
681 | "type" : "integer" | |
682 | } | |
683 | } | |
684 | }, | |
685 | "leaf" : 0, | |
686 | "path" : "/config/ruledb/who/{ogroup}/ip", | |
687 | "text" : "ip" | |
688 | }, | |
689 | { | |
690 | "children" : [ | |
691 | { | |
692 | "info" : { | |
693 | "GET" : { | |
694 | "description" : "Read 'IP Network' object settings.", | |
695 | "method" : "GET", | |
696 | "name" : "read_network", | |
697 | "parameters" : { | |
698 | "additionalProperties" : 0, | |
699 | "properties" : { | |
700 | "id" : { | |
701 | "description" : "Object ID.", | |
702 | "type" : "integer", | |
703 | "typetext" : "<integer>" | |
704 | }, | |
705 | "ogroup" : { | |
706 | "description" : "Object Groups ID.", | |
707 | "type" : "integer", | |
708 | "typetext" : "<integer>" | |
709 | } | |
710 | } | |
711 | }, | |
712 | "proxyto" : "master", | |
713 | "returns" : { | |
714 | "properties" : { | |
715 | "id" : { | |
716 | "type" : "integer" | |
717 | } | |
718 | }, | |
719 | "type" : "object" | |
720 | } | |
721 | }, | |
722 | "PUT" : { | |
723 | "description" : "Update 'IP Network' object.", | |
724 | "method" : "PUT", | |
725 | "name" : "update_network", | |
726 | "parameters" : { | |
727 | "additionalProperties" : 0, | |
728 | "properties" : { | |
729 | "cidr" : { | |
730 | "description" : "Network address in CIDR notation.", | |
731 | "format" : "CIDR", | |
732 | "type" : "string", | |
733 | "typetext" : "<string>" | |
734 | }, | |
735 | "id" : { | |
736 | "description" : "Object ID.", | |
737 | "type" : "integer", | |
738 | "typetext" : "<integer>" | |
739 | }, | |
740 | "ogroup" : { | |
741 | "description" : "Object Groups ID.", | |
742 | "type" : "integer", | |
743 | "typetext" : "<integer>" | |
744 | } | |
745 | } | |
746 | }, | |
747 | "proxyto" : "master", | |
748 | "returns" : { | |
749 | "type" : "null" | |
750 | } | |
751 | } | |
752 | }, | |
753 | "leaf" : 1, | |
754 | "path" : "/config/ruledb/who/{ogroup}/network/{id}", | |
755 | "text" : "{id}" | |
756 | } | |
757 | ], | |
758 | "info" : { | |
759 | "POST" : { | |
760 | "description" : "Add 'IP Network' object.", | |
761 | "method" : "POST", | |
762 | "name" : "network", | |
763 | "parameters" : { | |
764 | "additionalProperties" : 0, | |
765 | "properties" : { | |
766 | "cidr" : { | |
767 | "description" : "Network address in CIDR notation.", | |
768 | "format" : "CIDR", | |
769 | "type" : "string", | |
770 | "typetext" : "<string>" | |
771 | }, | |
772 | "ogroup" : { | |
773 | "description" : "Object Groups ID.", | |
774 | "type" : "integer", | |
775 | "typetext" : "<integer>" | |
776 | } | |
777 | } | |
778 | }, | |
779 | "proxyto" : "master", | |
780 | "returns" : { | |
781 | "description" : "The object ID.", | |
782 | "type" : "integer" | |
783 | } | |
784 | } | |
785 | }, | |
786 | "leaf" : 0, | |
787 | "path" : "/config/ruledb/who/{ogroup}/network", | |
788 | "text" : "network" | |
789 | } | |
790 | ], | |
791 | "info" : { | |
792 | "DELETE" : { | |
793 | "description" : "Delete a 'who' group.", | |
794 | "method" : "DELETE", | |
795 | "name" : "delete_who_group", | |
796 | "parameters" : { | |
797 | "additionalProperties" : 0, | |
798 | "properties" : { | |
799 | "ogroup" : { | |
800 | "description" : "Object Group ID.", | |
801 | "type" : "integer", | |
802 | "typetext" : "<integer>" | |
803 | } | |
804 | } | |
805 | }, | |
806 | "protected" : 1, | |
807 | "proxyto" : "master", | |
808 | "returns" : { | |
809 | "type" : "null" | |
810 | } | |
811 | }, | |
812 | "GET" : { | |
813 | "description" : "Directory index.", | |
814 | "method" : "GET", | |
815 | "name" : "index", | |
816 | "parameters" : { | |
817 | "additionalProperties" : 0, | |
818 | "properties" : { | |
819 | "ogroup" : { | |
820 | "description" : "Object Group ID.", | |
821 | "type" : "integer", | |
822 | "typetext" : "<integer>" | |
823 | } | |
824 | } | |
825 | }, | |
826 | "returns" : { | |
827 | "items" : { | |
828 | "properties" : { | |
829 | "subdir" : { | |
830 | "type" : "string" | |
831 | } | |
832 | }, | |
833 | "type" : "object" | |
834 | }, | |
835 | "links" : [ | |
836 | { | |
837 | "href" : "{subdir}", | |
838 | "rel" : "child" | |
839 | } | |
840 | ], | |
841 | "type" : "array" | |
842 | } | |
843 | } | |
844 | }, | |
845 | "leaf" : 0, | |
846 | "path" : "/config/ruledb/who/{ogroup}", | |
847 | "text" : "{ogroup}" | |
848 | } | |
849 | ], | |
410dc2c9 DM |
850 | "info" : { |
851 | "GET" : { | |
eff914dc | 852 | "description" : "Get list of 'who' groups.", |
410dc2c9 | 853 | "method" : "GET", |
eff914dc | 854 | "name" : "list_who_groups", |
410dc2c9 DM |
855 | "parameters" : { |
856 | "additionalProperties" : 0 | |
857 | }, | |
858 | "protected" : 1, | |
859 | "proxyto" : "master", | |
860 | "returns" : { | |
861 | "items" : { | |
eff914dc DM |
862 | "properties" : { |
863 | "id" : { | |
864 | "type" : "integer" | |
865 | } | |
866 | }, | |
410dc2c9 DM |
867 | "type" : "object" |
868 | }, | |
869 | "type" : "array" | |
870 | } | |
eff914dc DM |
871 | }, |
872 | "POST" : { | |
873 | "description" : "Create a new 'who' group.", | |
874 | "method" : "POST", | |
875 | "name" : "create_who_group", | |
876 | "parameters" : { | |
877 | "additionalProperties" : 0, | |
878 | "properties" : { | |
879 | "info" : { | |
880 | "description" : "Informational comment.", | |
881 | "maxLength" : 255, | |
882 | "optional" : 1, | |
883 | "type" : "string", | |
884 | "typetext" : "<string>" | |
885 | }, | |
886 | "name" : { | |
887 | "description" : "Group name.", | |
888 | "maxLength" : 255, | |
889 | "type" : "string", | |
890 | "typetext" : "<string>" | |
891 | } | |
892 | } | |
893 | }, | |
894 | "protected" : 1, | |
895 | "proxyto" : "master", | |
896 | "returns" : { | |
897 | "type" : "integer" | |
898 | } | |
410dc2c9 DM |
899 | } |
900 | }, | |
eff914dc | 901 | "leaf" : 0, |
410dc2c9 DM |
902 | "path" : "/config/ruledb/who", |
903 | "text" : "who" | |
904 | } | |
905 | ], | |
906 | "info" : { | |
907 | "GET" : { | |
908 | "description" : "Directory index.", | |
909 | "method" : "GET", | |
910 | "name" : "index", | |
911 | "parameters" : { | |
912 | "additionalProperties" : 0 | |
913 | }, | |
914 | "returns" : { | |
915 | "items" : { | |
916 | "properties" : {}, | |
917 | "type" : "object" | |
918 | }, | |
919 | "links" : [ | |
920 | { | |
921 | "href" : "{name}", | |
922 | "rel" : "child" | |
923 | } | |
924 | ], | |
925 | "type" : "array" | |
926 | } | |
927 | } | |
928 | }, | |
929 | "leaf" : 0, | |
930 | "path" : "/config/ruledb", | |
931 | "text" : "ruledb" | |
932 | }, | |
933 | { | |
934 | "children" : [ | |
935 | { | |
eff914dc DM |
936 | "children" : [ |
937 | { | |
938 | "info" : { | |
939 | "DELETE" : { | |
940 | "description" : "Remove an object from the SMTP whitelist.", | |
941 | "method" : "DELETE", | |
942 | "name" : "delete_object", | |
943 | "parameters" : { | |
944 | "additionalProperties" : 0, | |
945 | "properties" : { | |
946 | "id" : { | |
947 | "description" : "Object ID.", | |
948 | "type" : "integer", | |
949 | "typetext" : "<integer>" | |
950 | } | |
951 | } | |
952 | }, | |
953 | "proxyto" : "master", | |
954 | "returns" : { | |
955 | "type" : "null" | |
956 | } | |
957 | } | |
958 | }, | |
959 | "leaf" : 1, | |
960 | "path" : "/config/whitelist/objects/{id}", | |
961 | "text" : "{id}" | |
962 | } | |
963 | ], | |
410dc2c9 | 964 | "info" : { |
eff914dc DM |
965 | "GET" : { |
966 | "description" : "Get list of all SMTP whitelist entries.", | |
967 | "method" : "GET", | |
968 | "name" : "objects", | |
969 | "parameters" : { | |
970 | "additionalProperties" : 0 | |
971 | }, | |
972 | "proxyto" : "master", | |
973 | "returns" : { | |
974 | "items" : { | |
975 | "properties" : { | |
976 | "id" : { | |
977 | "type" : "integer" | |
978 | } | |
979 | }, | |
980 | "type" : "object" | |
981 | }, | |
982 | "links" : [ | |
983 | { | |
984 | "href" : "{id}", | |
985 | "rel" : "child" | |
986 | } | |
987 | ], | |
988 | "type" : "array" | |
989 | } | |
990 | } | |
991 | }, | |
992 | "leaf" : 0, | |
993 | "path" : "/config/whitelist/objects", | |
994 | "text" : "objects" | |
995 | }, | |
996 | { | |
997 | "children" : [ | |
998 | { | |
999 | "info" : { | |
1000 | "GET" : { | |
1001 | "description" : "Read 'Mail address' object settings.", | |
1002 | "method" : "GET", | |
1003 | "name" : "read_email", | |
1004 | "parameters" : { | |
1005 | "additionalProperties" : 0, | |
1006 | "properties" : { | |
1007 | "id" : { | |
1008 | "description" : "Object ID.", | |
1009 | "type" : "integer", | |
1010 | "typetext" : "<integer>" | |
1011 | } | |
1012 | } | |
1013 | }, | |
1014 | "proxyto" : "master", | |
1015 | "returns" : { | |
1016 | "properties" : { | |
1017 | "id" : { | |
1018 | "type" : "integer" | |
1019 | } | |
1020 | }, | |
1021 | "type" : "object" | |
1022 | } | |
1023 | }, | |
1024 | "PUT" : { | |
1025 | "description" : "Update 'Mail address' object.", | |
1026 | "method" : "PUT", | |
1027 | "name" : "update_email", | |
1028 | "parameters" : { | |
1029 | "additionalProperties" : 0, | |
1030 | "properties" : { | |
1031 | "email" : { | |
1032 | "description" : "Email address.", | |
1033 | "format" : "email", | |
1034 | "type" : "string", | |
1035 | "typetext" : "<string>" | |
1036 | }, | |
1037 | "id" : { | |
1038 | "description" : "Object ID.", | |
1039 | "type" : "integer", | |
1040 | "typetext" : "<integer>" | |
1041 | } | |
1042 | } | |
1043 | }, | |
1044 | "proxyto" : "master", | |
1045 | "returns" : { | |
1046 | "type" : "null" | |
1047 | } | |
1048 | } | |
1049 | }, | |
1050 | "leaf" : 1, | |
1051 | "path" : "/config/whitelist/email/{id}", | |
1052 | "text" : "{id}" | |
1053 | } | |
1054 | ], | |
1055 | "info" : { | |
1056 | "POST" : { | |
1057 | "description" : "Add 'Mail address' object.", | |
1058 | "method" : "POST", | |
1059 | "name" : "email", | |
410dc2c9 DM |
1060 | "parameters" : { |
1061 | "additionalProperties" : 0, | |
1062 | "properties" : { | |
eff914dc DM |
1063 | "email" : { |
1064 | "description" : "Email address.", | |
1065 | "format" : "email", | |
410dc2c9 DM |
1066 | "type" : "string", |
1067 | "typetext" : "<string>" | |
1068 | } | |
1069 | } | |
1070 | }, | |
410dc2c9 DM |
1071 | "proxyto" : "master", |
1072 | "returns" : { | |
eff914dc DM |
1073 | "description" : "The object ID.", |
1074 | "type" : "integer" | |
410dc2c9 | 1075 | } |
eff914dc DM |
1076 | } |
1077 | }, | |
1078 | "leaf" : 0, | |
1079 | "path" : "/config/whitelist/email", | |
1080 | "text" : "email" | |
1081 | }, | |
1082 | { | |
1083 | "children" : [ | |
1084 | { | |
1085 | "info" : { | |
1086 | "GET" : { | |
1087 | "description" : "Read 'Mail address' object settings.", | |
1088 | "method" : "GET", | |
1089 | "name" : "read_receiver", | |
1090 | "parameters" : { | |
1091 | "additionalProperties" : 0, | |
1092 | "properties" : { | |
1093 | "id" : { | |
1094 | "description" : "Object ID.", | |
1095 | "type" : "integer", | |
1096 | "typetext" : "<integer>" | |
1097 | } | |
1098 | } | |
1099 | }, | |
1100 | "proxyto" : "master", | |
1101 | "returns" : { | |
1102 | "properties" : { | |
1103 | "id" : { | |
1104 | "type" : "integer" | |
1105 | } | |
1106 | }, | |
1107 | "type" : "object" | |
1108 | } | |
1109 | }, | |
1110 | "PUT" : { | |
1111 | "description" : "Update 'Mail address' object.", | |
1112 | "method" : "PUT", | |
1113 | "name" : "update_receiver", | |
1114 | "parameters" : { | |
1115 | "additionalProperties" : 0, | |
1116 | "properties" : { | |
1117 | "email" : { | |
1118 | "description" : "Email address.", | |
1119 | "format" : "email", | |
1120 | "type" : "string", | |
1121 | "typetext" : "<string>" | |
1122 | }, | |
1123 | "id" : { | |
1124 | "description" : "Object ID.", | |
1125 | "type" : "integer", | |
1126 | "typetext" : "<integer>" | |
1127 | } | |
1128 | } | |
1129 | }, | |
1130 | "proxyto" : "master", | |
1131 | "returns" : { | |
1132 | "type" : "null" | |
1133 | } | |
1134 | } | |
1135 | }, | |
1136 | "leaf" : 1, | |
1137 | "path" : "/config/whitelist/receiver/{id}", | |
1138 | "text" : "{id}" | |
1139 | } | |
1140 | ], | |
1141 | "info" : { | |
1142 | "POST" : { | |
1143 | "description" : "Add 'Mail address' object.", | |
1144 | "method" : "POST", | |
1145 | "name" : "receiver", | |
410dc2c9 DM |
1146 | "parameters" : { |
1147 | "additionalProperties" : 0, | |
1148 | "properties" : { | |
eff914dc DM |
1149 | "email" : { |
1150 | "description" : "Email address.", | |
1151 | "format" : "email", | |
410dc2c9 DM |
1152 | "type" : "string", |
1153 | "typetext" : "<string>" | |
1154 | } | |
1155 | } | |
1156 | }, | |
410dc2c9 | 1157 | "proxyto" : "master", |
eff914dc DM |
1158 | "returns" : { |
1159 | "description" : "The object ID.", | |
1160 | "type" : "integer" | |
1161 | } | |
1162 | } | |
1163 | }, | |
1164 | "leaf" : 0, | |
1165 | "path" : "/config/whitelist/receiver", | |
1166 | "text" : "receiver" | |
1167 | }, | |
1168 | { | |
1169 | "children" : [ | |
1170 | { | |
1171 | "info" : { | |
1172 | "GET" : { | |
1173 | "description" : "Read 'Domain' object settings.", | |
1174 | "method" : "GET", | |
1175 | "name" : "read_domain", | |
1176 | "parameters" : { | |
1177 | "additionalProperties" : 0, | |
1178 | "properties" : { | |
1179 | "id" : { | |
1180 | "description" : "Object ID.", | |
1181 | "type" : "integer", | |
1182 | "typetext" : "<integer>" | |
1183 | } | |
1184 | } | |
1185 | }, | |
1186 | "proxyto" : "master", | |
1187 | "returns" : { | |
1188 | "properties" : { | |
1189 | "id" : { | |
1190 | "type" : "integer" | |
1191 | } | |
1192 | }, | |
1193 | "type" : "object" | |
1194 | } | |
1195 | }, | |
1196 | "PUT" : { | |
1197 | "description" : "Update 'Domain' object.", | |
1198 | "method" : "PUT", | |
1199 | "name" : "update_domain", | |
1200 | "parameters" : { | |
1201 | "additionalProperties" : 0, | |
1202 | "properties" : { | |
1203 | "domain" : { | |
1204 | "description" : "DNS domain name (Sender).", | |
1205 | "format" : "dns-name", | |
1206 | "type" : "string", | |
1207 | "typetext" : "<string>" | |
1208 | }, | |
1209 | "id" : { | |
1210 | "description" : "Object ID.", | |
1211 | "type" : "integer", | |
1212 | "typetext" : "<integer>" | |
1213 | } | |
1214 | } | |
1215 | }, | |
1216 | "proxyto" : "master", | |
1217 | "returns" : { | |
1218 | "type" : "null" | |
1219 | } | |
1220 | } | |
1221 | }, | |
1222 | "leaf" : 1, | |
1223 | "path" : "/config/whitelist/domain/{id}", | |
1224 | "text" : "{id}" | |
1225 | } | |
1226 | ], | |
1227 | "info" : { | |
1228 | "POST" : { | |
1229 | "description" : "Add 'Domain' object.", | |
1230 | "method" : "POST", | |
1231 | "name" : "domain", | |
410dc2c9 DM |
1232 | "parameters" : { |
1233 | "additionalProperties" : 0, | |
1234 | "properties" : { | |
eff914dc DM |
1235 | "domain" : { |
1236 | "description" : "DNS domain name (Sender).", | |
1237 | "format" : "dns-name", | |
410dc2c9 DM |
1238 | "type" : "string", |
1239 | "typetext" : "<string>" | |
eff914dc DM |
1240 | } |
1241 | } | |
1242 | }, | |
1243 | "proxyto" : "master", | |
1244 | "returns" : { | |
1245 | "description" : "The object ID.", | |
1246 | "type" : "integer" | |
1247 | } | |
1248 | } | |
1249 | }, | |
1250 | "leaf" : 0, | |
1251 | "path" : "/config/whitelist/domain", | |
1252 | "text" : "domain" | |
1253 | }, | |
1254 | { | |
1255 | "children" : [ | |
1256 | { | |
1257 | "info" : { | |
1258 | "GET" : { | |
1259 | "description" : "Read 'Domain' object settings.", | |
1260 | "method" : "GET", | |
1261 | "name" : "read_receiver_domain", | |
1262 | "parameters" : { | |
1263 | "additionalProperties" : 0, | |
1264 | "properties" : { | |
1265 | "id" : { | |
1266 | "description" : "Object ID.", | |
1267 | "type" : "integer", | |
1268 | "typetext" : "<integer>" | |
1269 | } | |
1270 | } | |
410dc2c9 | 1271 | }, |
eff914dc DM |
1272 | "proxyto" : "master", |
1273 | "returns" : { | |
1274 | "properties" : { | |
1275 | "id" : { | |
1276 | "type" : "integer" | |
1277 | } | |
1278 | }, | |
1279 | "type" : "object" | |
1280 | } | |
1281 | }, | |
1282 | "PUT" : { | |
1283 | "description" : "Update 'Domain' object.", | |
1284 | "method" : "PUT", | |
1285 | "name" : "update_receiver_domain", | |
1286 | "parameters" : { | |
1287 | "additionalProperties" : 0, | |
1288 | "properties" : { | |
1289 | "domain" : { | |
1290 | "description" : "DNS domain name (Sender).", | |
1291 | "format" : "dns-name", | |
1292 | "type" : "string", | |
1293 | "typetext" : "<string>" | |
1294 | }, | |
1295 | "id" : { | |
1296 | "description" : "Object ID.", | |
1297 | "type" : "integer", | |
1298 | "typetext" : "<integer>" | |
1299 | } | |
1300 | } | |
410dc2c9 | 1301 | }, |
eff914dc DM |
1302 | "proxyto" : "master", |
1303 | "returns" : { | |
1304 | "type" : "null" | |
1305 | } | |
1306 | } | |
1307 | }, | |
1308 | "leaf" : 1, | |
1309 | "path" : "/config/whitelist/receiver_domain/{id}", | |
1310 | "text" : "{id}" | |
1311 | } | |
1312 | ], | |
1313 | "info" : { | |
1314 | "POST" : { | |
1315 | "description" : "Add 'Domain' object.", | |
1316 | "method" : "POST", | |
1317 | "name" : "receiver_domain", | |
1318 | "parameters" : { | |
1319 | "additionalProperties" : 0, | |
1320 | "properties" : { | |
1321 | "domain" : { | |
1322 | "description" : "DNS domain name (Sender).", | |
1323 | "format" : "dns-name", | |
410dc2c9 DM |
1324 | "type" : "string", |
1325 | "typetext" : "<string>" | |
eff914dc DM |
1326 | } |
1327 | } | |
1328 | }, | |
1329 | "proxyto" : "master", | |
1330 | "returns" : { | |
1331 | "description" : "The object ID.", | |
1332 | "type" : "integer" | |
1333 | } | |
1334 | } | |
1335 | }, | |
1336 | "leaf" : 0, | |
1337 | "path" : "/config/whitelist/receiver_domain", | |
1338 | "text" : "receiver_domain" | |
1339 | }, | |
1340 | { | |
1341 | "children" : [ | |
1342 | { | |
1343 | "info" : { | |
1344 | "GET" : { | |
1345 | "description" : "Read 'Regular Expression' object settings.", | |
1346 | "method" : "GET", | |
1347 | "name" : "read_regex", | |
1348 | "parameters" : { | |
1349 | "additionalProperties" : 0, | |
1350 | "properties" : { | |
1351 | "id" : { | |
1352 | "description" : "Object ID.", | |
1353 | "type" : "integer", | |
1354 | "typetext" : "<integer>" | |
1355 | } | |
1356 | } | |
410dc2c9 | 1357 | }, |
eff914dc DM |
1358 | "proxyto" : "master", |
1359 | "returns" : { | |
1360 | "properties" : { | |
1361 | "id" : { | |
1362 | "type" : "integer" | |
1363 | } | |
1364 | }, | |
1365 | "type" : "object" | |
1366 | } | |
1367 | }, | |
1368 | "PUT" : { | |
1369 | "description" : "Update 'Regular Expression' object.", | |
1370 | "method" : "PUT", | |
1371 | "name" : "update_regex", | |
1372 | "parameters" : { | |
1373 | "additionalProperties" : 0, | |
1374 | "properties" : { | |
1375 | "id" : { | |
1376 | "description" : "Object ID.", | |
1377 | "type" : "integer", | |
1378 | "typetext" : "<integer>" | |
1379 | }, | |
1380 | "regex" : { | |
1381 | "description" : "Email address regular expression.", | |
1382 | "maxLength" : 1024, | |
1383 | "type" : "string", | |
1384 | "typetext" : "<string>" | |
1385 | } | |
1386 | } | |
1387 | }, | |
1388 | "proxyto" : "master", | |
1389 | "returns" : { | |
1390 | "type" : "null" | |
1391 | } | |
1392 | } | |
1393 | }, | |
1394 | "leaf" : 1, | |
1395 | "path" : "/config/whitelist/regex/{id}", | |
1396 | "text" : "{id}" | |
1397 | } | |
1398 | ], | |
1399 | "info" : { | |
1400 | "POST" : { | |
1401 | "description" : "Add 'Regular Expression' object.", | |
1402 | "method" : "POST", | |
1403 | "name" : "regex", | |
1404 | "parameters" : { | |
1405 | "additionalProperties" : 0, | |
1406 | "properties" : { | |
1407 | "regex" : { | |
1408 | "description" : "Email address regular expression.", | |
1409 | "maxLength" : 1024, | |
410dc2c9 DM |
1410 | "type" : "string", |
1411 | "typetext" : "<string>" | |
eff914dc DM |
1412 | } |
1413 | } | |
1414 | }, | |
1415 | "proxyto" : "master", | |
1416 | "returns" : { | |
1417 | "description" : "The object ID.", | |
1418 | "type" : "integer" | |
1419 | } | |
1420 | } | |
1421 | }, | |
1422 | "leaf" : 0, | |
1423 | "path" : "/config/whitelist/regex", | |
1424 | "text" : "regex" | |
1425 | }, | |
1426 | { | |
1427 | "children" : [ | |
1428 | { | |
1429 | "info" : { | |
1430 | "GET" : { | |
1431 | "description" : "Read 'Regular Expression' object settings.", | |
1432 | "method" : "GET", | |
1433 | "name" : "read_receiver_regex", | |
1434 | "parameters" : { | |
1435 | "additionalProperties" : 0, | |
1436 | "properties" : { | |
1437 | "id" : { | |
1438 | "description" : "Object ID.", | |
1439 | "type" : "integer", | |
1440 | "typetext" : "<integer>" | |
1441 | } | |
1442 | } | |
1443 | }, | |
1444 | "proxyto" : "master", | |
1445 | "returns" : { | |
1446 | "properties" : { | |
1447 | "id" : { | |
1448 | "type" : "integer" | |
1449 | } | |
1450 | }, | |
1451 | "type" : "object" | |
1452 | } | |
1453 | }, | |
1454 | "PUT" : { | |
1455 | "description" : "Update 'Regular Expression' object.", | |
1456 | "method" : "PUT", | |
1457 | "name" : "update_receiver_regex", | |
1458 | "parameters" : { | |
1459 | "additionalProperties" : 0, | |
1460 | "properties" : { | |
1461 | "id" : { | |
1462 | "description" : "Object ID.", | |
1463 | "type" : "integer", | |
1464 | "typetext" : "<integer>" | |
1465 | }, | |
1466 | "regex" : { | |
1467 | "description" : "Email address regular expression.", | |
1468 | "maxLength" : 1024, | |
1469 | "type" : "string", | |
1470 | "typetext" : "<string>" | |
1471 | } | |
1472 | } | |
1473 | }, | |
1474 | "proxyto" : "master", | |
1475 | "returns" : { | |
1476 | "type" : "null" | |
1477 | } | |
1478 | } | |
1479 | }, | |
1480 | "leaf" : 1, | |
1481 | "path" : "/config/whitelist/receiver_regex/{id}", | |
1482 | "text" : "{id}" | |
1483 | } | |
1484 | ], | |
1485 | "info" : { | |
1486 | "POST" : { | |
1487 | "description" : "Add 'Regular Expression' object.", | |
1488 | "method" : "POST", | |
1489 | "name" : "receiver_regex", | |
1490 | "parameters" : { | |
1491 | "additionalProperties" : 0, | |
1492 | "properties" : { | |
1493 | "regex" : { | |
1494 | "description" : "Email address regular expression.", | |
1495 | "maxLength" : 1024, | |
1496 | "type" : "string", | |
1497 | "typetext" : "<string>" | |
1498 | } | |
1499 | } | |
1500 | }, | |
1501 | "proxyto" : "master", | |
1502 | "returns" : { | |
1503 | "description" : "The object ID.", | |
1504 | "type" : "integer" | |
1505 | } | |
1506 | } | |
1507 | }, | |
1508 | "leaf" : 0, | |
1509 | "path" : "/config/whitelist/receiver_regex", | |
1510 | "text" : "receiver_regex" | |
1511 | }, | |
1512 | { | |
1513 | "children" : [ | |
1514 | { | |
1515 | "info" : { | |
1516 | "GET" : { | |
1517 | "description" : "Read 'IP Address' object settings.", | |
1518 | "method" : "GET", | |
1519 | "name" : "read_ip", | |
1520 | "parameters" : { | |
1521 | "additionalProperties" : 0, | |
1522 | "properties" : { | |
1523 | "id" : { | |
1524 | "description" : "Object ID.", | |
1525 | "type" : "integer", | |
1526 | "typetext" : "<integer>" | |
1527 | } | |
1528 | } | |
1529 | }, | |
1530 | "proxyto" : "master", | |
1531 | "returns" : { | |
1532 | "properties" : { | |
1533 | "id" : { | |
1534 | "type" : "integer" | |
1535 | } | |
1536 | }, | |
1537 | "type" : "object" | |
1538 | } | |
1539 | }, | |
1540 | "PUT" : { | |
1541 | "description" : "Update 'IP Address' object.", | |
1542 | "method" : "PUT", | |
1543 | "name" : "update_ip", | |
1544 | "parameters" : { | |
1545 | "additionalProperties" : 0, | |
1546 | "properties" : { | |
1547 | "id" : { | |
1548 | "description" : "Object ID.", | |
1549 | "type" : "integer", | |
1550 | "typetext" : "<integer>" | |
1551 | }, | |
1552 | "ip" : { | |
1553 | "description" : "IP address", | |
1554 | "format" : "ip", | |
1555 | "type" : "string", | |
1556 | "typetext" : "<string>" | |
1557 | } | |
1558 | } | |
1559 | }, | |
1560 | "proxyto" : "master", | |
1561 | "returns" : { | |
1562 | "type" : "null" | |
1563 | } | |
1564 | } | |
1565 | }, | |
1566 | "leaf" : 1, | |
1567 | "path" : "/config/whitelist/ip/{id}", | |
1568 | "text" : "{id}" | |
1569 | } | |
1570 | ], | |
1571 | "info" : { | |
1572 | "POST" : { | |
1573 | "description" : "Add 'IP Address' object.", | |
1574 | "method" : "POST", | |
1575 | "name" : "ip", | |
1576 | "parameters" : { | |
1577 | "additionalProperties" : 0, | |
1578 | "properties" : { | |
1579 | "ip" : { | |
1580 | "description" : "IP address", | |
1581 | "format" : "ip", | |
1582 | "type" : "string", | |
1583 | "typetext" : "<string>" | |
1584 | } | |
1585 | } | |
1586 | }, | |
1587 | "proxyto" : "master", | |
1588 | "returns" : { | |
1589 | "description" : "The object ID.", | |
1590 | "type" : "integer" | |
1591 | } | |
1592 | } | |
1593 | }, | |
1594 | "leaf" : 0, | |
1595 | "path" : "/config/whitelist/ip", | |
1596 | "text" : "ip" | |
1597 | }, | |
1598 | { | |
1599 | "children" : [ | |
1600 | { | |
1601 | "info" : { | |
1602 | "GET" : { | |
1603 | "description" : "Read 'IP Network' object settings.", | |
1604 | "method" : "GET", | |
1605 | "name" : "read_network", | |
1606 | "parameters" : { | |
1607 | "additionalProperties" : 0, | |
1608 | "properties" : { | |
1609 | "id" : { | |
1610 | "description" : "Object ID.", | |
1611 | "type" : "integer", | |
1612 | "typetext" : "<integer>" | |
1613 | } | |
1614 | } | |
1615 | }, | |
1616 | "proxyto" : "master", | |
1617 | "returns" : { | |
1618 | "properties" : { | |
1619 | "id" : { | |
1620 | "type" : "integer" | |
1621 | } | |
1622 | }, | |
1623 | "type" : "object" | |
1624 | } | |
1625 | }, | |
1626 | "PUT" : { | |
1627 | "description" : "Update 'IP Network' object.", | |
1628 | "method" : "PUT", | |
1629 | "name" : "update_network", | |
1630 | "parameters" : { | |
1631 | "additionalProperties" : 0, | |
1632 | "properties" : { | |
1633 | "cidr" : { | |
1634 | "description" : "Network address in CIDR notation.", | |
1635 | "format" : "CIDR", | |
1636 | "type" : "string", | |
1637 | "typetext" : "<string>" | |
1638 | }, | |
1639 | "id" : { | |
1640 | "description" : "Object ID.", | |
1641 | "type" : "integer", | |
1642 | "typetext" : "<integer>" | |
1643 | } | |
1644 | } | |
1645 | }, | |
1646 | "proxyto" : "master", | |
1647 | "returns" : { | |
1648 | "type" : "null" | |
1649 | } | |
1650 | } | |
1651 | }, | |
1652 | "leaf" : 1, | |
1653 | "path" : "/config/whitelist/network/{id}", | |
1654 | "text" : "{id}" | |
1655 | } | |
1656 | ], | |
1657 | "info" : { | |
1658 | "POST" : { | |
1659 | "description" : "Add 'IP Network' object.", | |
1660 | "method" : "POST", | |
1661 | "name" : "network", | |
1662 | "parameters" : { | |
1663 | "additionalProperties" : 0, | |
1664 | "properties" : { | |
1665 | "cidr" : { | |
1666 | "description" : "Network address in CIDR notation.", | |
1667 | "format" : "CIDR", | |
1668 | "type" : "string", | |
1669 | "typetext" : "<string>" | |
1670 | } | |
1671 | } | |
1672 | }, | |
1673 | "proxyto" : "master", | |
1674 | "returns" : { | |
1675 | "description" : "The object ID.", | |
1676 | "type" : "integer" | |
1677 | } | |
1678 | } | |
1679 | }, | |
1680 | "leaf" : 0, | |
1681 | "path" : "/config/whitelist/network", | |
1682 | "text" : "network" | |
1683 | } | |
1684 | ], | |
1685 | "info" : { | |
1686 | "GET" : { | |
1687 | "description" : "Directory index.", | |
1688 | "method" : "GET", | |
1689 | "name" : "index", | |
1690 | "parameters" : { | |
1691 | "additionalProperties" : 0 | |
1692 | }, | |
1693 | "returns" : { | |
1694 | "items" : { | |
1695 | "properties" : { | |
1696 | "subdir" : { | |
1697 | "type" : "string" | |
1698 | } | |
1699 | }, | |
1700 | "type" : "object" | |
1701 | }, | |
1702 | "links" : [ | |
1703 | { | |
1704 | "href" : "{subdir}", | |
1705 | "rel" : "child" | |
1706 | } | |
1707 | ], | |
1708 | "type" : "array" | |
1709 | } | |
1710 | } | |
1711 | }, | |
1712 | "leaf" : 0, | |
1713 | "path" : "/config/whitelist", | |
1714 | "text" : "whitelist" | |
1715 | }, | |
1716 | { | |
1717 | "children" : [ | |
1718 | { | |
1719 | "info" : { | |
1720 | "DELETE" : { | |
1721 | "description" : "Delete an LDAP server entry.", | |
1722 | "method" : "DELETE", | |
1723 | "name" : "delete", | |
1724 | "parameters" : { | |
1725 | "additionalProperties" : 0, | |
1726 | "properties" : { | |
1727 | "section" : { | |
1728 | "description" : "Secion ID.", | |
1729 | "format" : "pve-configid", | |
1730 | "type" : "string", | |
1731 | "typetext" : "<string>" | |
1732 | } | |
1733 | } | |
1734 | }, | |
1735 | "protected" : 1, | |
1736 | "proxyto" : "master", | |
1737 | "returns" : { | |
1738 | "type" : "null" | |
1739 | } | |
1740 | }, | |
1741 | "GET" : { | |
1742 | "description" : "Get LDAP server configuration.", | |
1743 | "method" : "GET", | |
1744 | "name" : "read", | |
1745 | "parameters" : { | |
1746 | "additionalProperties" : 0, | |
1747 | "properties" : { | |
1748 | "section" : { | |
1749 | "description" : "Secion ID.", | |
1750 | "format" : "pve-configid", | |
1751 | "type" : "string", | |
1752 | "typetext" : "<string>" | |
1753 | } | |
1754 | } | |
1755 | }, | |
1756 | "protected" : 1, | |
1757 | "proxyto" : "master", | |
1758 | "returns" : {} | |
1759 | }, | |
1760 | "PUT" : { | |
1761 | "description" : "Update LDAP server settings.", | |
1762 | "method" : "PUT", | |
1763 | "name" : "update", | |
1764 | "parameters" : { | |
1765 | "additionalProperties" : 0, | |
1766 | "properties" : { | |
1767 | "accountattr" : { | |
1768 | "default" : "sAMAccountName", | |
1769 | "description" : "Account attribute name name.", | |
1770 | "optional" : 1, | |
1771 | "pattern" : "[a-zA-Z0-9]+", | |
1772 | "type" : "string" | |
1773 | }, | |
1774 | "basedn" : { | |
1775 | "description" : "Base domain name.", | |
1776 | "optional" : 1, | |
1777 | "type" : "string", | |
1778 | "typetext" : "<string>" | |
1779 | }, | |
1780 | "binddn" : { | |
1781 | "description" : "Bind domain name.", | |
1782 | "optional" : 1, | |
1783 | "type" : "string", | |
1784 | "typetext" : "<string>" | |
1785 | }, | |
1786 | "bindpw" : { | |
1787 | "description" : "Bind password.", | |
1788 | "optional" : 1, | |
1789 | "type" : "string", | |
1790 | "typetext" : "<string>" | |
1791 | }, | |
1792 | "delete" : { | |
1793 | "description" : "A list of settings you want to delete.", | |
1794 | "format" : "pve-configid-list", | |
1795 | "maxLength" : 4096, | |
1796 | "optional" : 1, | |
1797 | "type" : "string", | |
1798 | "typetext" : "<string>" | |
1799 | }, | |
1800 | "digest" : { | |
1801 | "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", | |
1802 | "maxLength" : 40, | |
1803 | "optional" : 1, | |
1804 | "type" : "string", | |
1805 | "typetext" : "<string>" | |
1806 | }, | |
1807 | "filter" : { | |
1808 | "description" : "LDAP filter.", | |
1809 | "optional" : 1, | |
1810 | "type" : "string", | |
1811 | "typetext" : "<string>" | |
1812 | }, | |
1813 | "groupbasedn" : { | |
1814 | "description" : "Base domain name for groups.", | |
1815 | "optional" : 1, | |
1816 | "type" : "string", | |
1817 | "typetext" : "<string>" | |
1818 | }, | |
1819 | "mailattr" : { | |
1820 | "default" : "mail, userPrincipalName, proxyAddresses, othermailbox", | |
1821 | "description" : "List of mail attribute names.", | |
1822 | "format" : "string-list", | |
1823 | "optional" : 1, | |
1824 | "pattern" : "[a-zA-Z0-9]+", | |
1825 | "type" : "string" | |
1826 | }, | |
1827 | "mode" : { | |
1828 | "default" : "ldap", | |
1829 | "description" : "LDAP protocol mode ('ldap' or 'ldaps').", | |
1830 | "enum" : [ | |
1831 | "ldap", | |
1832 | "ldaps" | |
1833 | ], | |
1834 | "optional" : 1, | |
1835 | "type" : "string" | |
1836 | }, | |
1837 | "port" : { | |
1838 | "description" : "Specify the port to connect to.", | |
1839 | "maximum" : 65535, | |
1840 | "minimum" : 1, | |
1841 | "optional" : 1, | |
1842 | "type" : "integer", | |
1843 | "typetext" : "<integer> (1 - 65535)" | |
1844 | }, | |
1845 | "section" : { | |
1846 | "description" : "Secion ID.", | |
1847 | "format" : "pve-configid", | |
1848 | "type" : "string", | |
1849 | "typetext" : "<string>" | |
1850 | }, | |
1851 | "server1" : { | |
1852 | "description" : "Server address.", | |
1853 | "format" : "address", | |
1854 | "optional" : 1, | |
1855 | "type" : "string", | |
1856 | "typetext" : "<string>" | |
1857 | }, | |
1858 | "server2" : { | |
1859 | "description" : "Fallback server address. Userd when the first server is not available.", | |
1860 | "format" : "address", | |
1861 | "optional" : 1, | |
1862 | "type" : "string", | |
1863 | "typetext" : "<string>" | |
1864 | } | |
1865 | }, | |
1866 | "type" : "object" | |
1867 | }, | |
1868 | "protected" : 1, | |
1869 | "proxyto" : "master", | |
1870 | "returns" : { | |
1871 | "type" : "null" | |
1872 | } | |
1873 | } | |
1874 | }, | |
1875 | "leaf" : 1, | |
1876 | "path" : "/config/ldap/{section}", | |
1877 | "text" : "{section}" | |
1878 | } | |
1879 | ], | |
1880 | "info" : { | |
1881 | "GET" : { | |
1882 | "description" : "LDAP server list.", | |
1883 | "method" : "GET", | |
1884 | "name" : "index", | |
1885 | "parameters" : { | |
1886 | "additionalProperties" : 0 | |
1887 | }, | |
1888 | "protected" : 1, | |
1889 | "proxyto" : "master", | |
1890 | "returns" : { | |
1891 | "items" : { | |
1892 | "properties" : { | |
1893 | "mode" : { | |
1894 | "type" : "string" | |
1895 | }, | |
1896 | "section" : { | |
1897 | "type" : "string" | |
1898 | }, | |
1899 | "server1" : { | |
1900 | "type" : "string" | |
1901 | } | |
1902 | }, | |
1903 | "type" : "object" | |
1904 | }, | |
1905 | "links" : [ | |
1906 | { | |
1907 | "href" : "{section}", | |
1908 | "rel" : "child" | |
1909 | } | |
1910 | ], | |
1911 | "type" : "array" | |
1912 | } | |
1913 | }, | |
1914 | "POST" : { | |
1915 | "description" : "Add LDAP server.", | |
1916 | "method" : "POST", | |
1917 | "name" : "create", | |
1918 | "parameters" : { | |
1919 | "additionalProperties" : 0, | |
1920 | "properties" : { | |
1921 | "accountattr" : { | |
1922 | "default" : "sAMAccountName", | |
1923 | "description" : "Account attribute name name.", | |
1924 | "optional" : 1, | |
1925 | "pattern" : "[a-zA-Z0-9]+", | |
1926 | "type" : "string" | |
1927 | }, | |
1928 | "basedn" : { | |
1929 | "description" : "Base domain name.", | |
1930 | "optional" : 1, | |
1931 | "type" : "string", | |
1932 | "typetext" : "<string>" | |
1933 | }, | |
1934 | "binddn" : { | |
1935 | "description" : "Bind domain name.", | |
1936 | "optional" : 1, | |
1937 | "type" : "string", | |
1938 | "typetext" : "<string>" | |
1939 | }, | |
1940 | "bindpw" : { | |
1941 | "description" : "Bind password.", | |
1942 | "optional" : 1, | |
1943 | "type" : "string", | |
1944 | "typetext" : "<string>" | |
1945 | }, | |
1946 | "filter" : { | |
1947 | "description" : "LDAP filter.", | |
1948 | "optional" : 1, | |
1949 | "type" : "string", | |
1950 | "typetext" : "<string>" | |
1951 | }, | |
1952 | "groupbasedn" : { | |
1953 | "description" : "Base domain name for groups.", | |
1954 | "optional" : 1, | |
1955 | "type" : "string", | |
1956 | "typetext" : "<string>" | |
1957 | }, | |
1958 | "mailattr" : { | |
1959 | "default" : "mail, userPrincipalName, proxyAddresses, othermailbox", | |
1960 | "description" : "List of mail attribute names.", | |
1961 | "format" : "string-list", | |
1962 | "optional" : 1, | |
1963 | "pattern" : "[a-zA-Z0-9]+", | |
1964 | "type" : "string" | |
1965 | }, | |
1966 | "mode" : { | |
1967 | "default" : "ldap", | |
1968 | "description" : "LDAP protocol mode ('ldap' or 'ldaps').", | |
1969 | "enum" : [ | |
1970 | "ldap", | |
1971 | "ldaps" | |
1972 | ], | |
1973 | "optional" : 1, | |
1974 | "type" : "string" | |
1975 | }, | |
1976 | "port" : { | |
1977 | "description" : "Specify the port to connect to.", | |
1978 | "maximum" : 65535, | |
1979 | "minimum" : 1, | |
1980 | "optional" : 1, | |
1981 | "type" : "integer", | |
1982 | "typetext" : "<integer> (1 - 65535)" | |
1983 | }, | |
1984 | "section" : { | |
1985 | "description" : "Secion ID.", | |
1986 | "format" : "pve-configid", | |
1987 | "type" : "string", | |
1988 | "typetext" : "<string>" | |
1989 | }, | |
1990 | "server1" : { | |
1991 | "description" : "Server address.", | |
1992 | "format" : "address", | |
1993 | "optional" : 0, | |
1994 | "type" : "string", | |
1995 | "typetext" : "<string>" | |
1996 | }, | |
1997 | "server2" : { | |
1998 | "description" : "Fallback server address. Userd when the first server is not available.", | |
1999 | "format" : "address", | |
2000 | "optional" : 1, | |
2001 | "type" : "string", | |
2002 | "typetext" : "<string>" | |
2003 | } | |
2004 | }, | |
2005 | "type" : "object" | |
2006 | }, | |
2007 | "protected" : 1, | |
2008 | "proxyto" : "master", | |
2009 | "returns" : { | |
2010 | "type" : "null" | |
2011 | } | |
2012 | } | |
2013 | }, | |
2014 | "leaf" : 0, | |
2015 | "path" : "/config/ldap", | |
2016 | "text" : "ldap" | |
2017 | }, | |
2018 | { | |
2019 | "children" : [ | |
2020 | { | |
2021 | "info" : { | |
2022 | "DELETE" : { | |
2023 | "description" : "Delete a relay domain", | |
2024 | "method" : "DELETE", | |
2025 | "name" : "delete", | |
2026 | "parameters" : { | |
2027 | "additionalProperties" : 0, | |
2028 | "properties" : { | |
2029 | "domain" : { | |
2030 | "description" : "Domain name.", | |
2031 | "format" : "dns-name", | |
2032 | "type" : "string", | |
2033 | "typetext" : "<string>" | |
2034 | } | |
2035 | } | |
2036 | }, | |
2037 | "protected" : 1, | |
2038 | "proxyto" : "master", | |
2039 | "returns" : { | |
2040 | "type" : "null" | |
2041 | } | |
2042 | }, | |
2043 | "GET" : { | |
2044 | "description" : "Read Domain data (comment).", | |
2045 | "method" : "GET", | |
2046 | "name" : "read", | |
2047 | "parameters" : { | |
2048 | "additionalProperties" : 0, | |
2049 | "properties" : { | |
2050 | "domain" : { | |
2051 | "description" : "Domain name.", | |
2052 | "format" : "dns-name", | |
2053 | "type" : "string", | |
2054 | "typetext" : "<string>" | |
2055 | } | |
2056 | } | |
2057 | }, | |
2058 | "proxyto" : "master", | |
2059 | "returns" : { | |
2060 | "properties" : { | |
2061 | "comment" : { | |
2062 | "type" : "string" | |
2063 | }, | |
2064 | "domain" : { | |
2065 | "type" : "string" | |
2066 | } | |
2067 | }, | |
2068 | "type" : "object" | |
2069 | } | |
2070 | }, | |
2071 | "PUT" : { | |
2072 | "description" : "Update relay domain data (comment).", | |
2073 | "method" : "PUT", | |
2074 | "name" : "write", | |
2075 | "parameters" : { | |
2076 | "additionalProperties" : 0, | |
2077 | "properties" : { | |
2078 | "comment" : { | |
2079 | "description" : "Comment.", | |
2080 | "type" : "string", | |
2081 | "typetext" : "<string>" | |
2082 | }, | |
2083 | "domain" : { | |
2084 | "description" : "Domain name.", | |
2085 | "format" : "dns-name", | |
2086 | "type" : "string", | |
2087 | "typetext" : "<string>" | |
2088 | } | |
2089 | } | |
2090 | }, | |
2091 | "protected" : 1, | |
2092 | "proxyto" : "master", | |
2093 | "returns" : { | |
2094 | "type" : "null" | |
2095 | } | |
2096 | } | |
2097 | }, | |
2098 | "leaf" : 1, | |
2099 | "path" : "/config/domains/{domain}", | |
2100 | "text" : "{domain}" | |
2101 | } | |
2102 | ], | |
2103 | "info" : { | |
2104 | "GET" : { | |
2105 | "description" : "List relay domains.", | |
2106 | "method" : "GET", | |
2107 | "name" : "index", | |
2108 | "parameters" : { | |
2109 | "additionalProperties" : 0 | |
2110 | }, | |
2111 | "proxyto" : "master", | |
2112 | "returns" : { | |
2113 | "items" : { | |
2114 | "properties" : { | |
2115 | "comment" : { | |
2116 | "type" : "string" | |
2117 | }, | |
2118 | "domain" : { | |
2119 | "type" : "string" | |
2120 | } | |
2121 | }, | |
2122 | "type" : "object" | |
2123 | }, | |
2124 | "links" : [ | |
2125 | { | |
2126 | "href" : "{domain}", | |
2127 | "rel" : "child" | |
2128 | } | |
2129 | ], | |
2130 | "type" : "array" | |
2131 | } | |
2132 | }, | |
2133 | "POST" : { | |
2134 | "description" : "Add relay domain.", | |
2135 | "method" : "POST", | |
2136 | "name" : "create", | |
2137 | "parameters" : { | |
2138 | "additionalProperties" : 0, | |
2139 | "properties" : { | |
2140 | "comment" : { | |
2141 | "description" : "Comment.", | |
2142 | "optional" : 1, | |
2143 | "type" : "string", | |
2144 | "typetext" : "<string>" | |
2145 | }, | |
2146 | "domain" : { | |
2147 | "description" : "Domain name.", | |
2148 | "format" : "dns-name", | |
2149 | "type" : "string", | |
2150 | "typetext" : "<string>" | |
2151 | } | |
2152 | } | |
2153 | }, | |
2154 | "protected" : 1, | |
2155 | "proxyto" : "master", | |
2156 | "returns" : { | |
2157 | "type" : "null" | |
2158 | } | |
2159 | } | |
2160 | }, | |
2161 | "leaf" : 0, | |
2162 | "path" : "/config/domains", | |
2163 | "text" : "domains" | |
2164 | }, | |
2165 | { | |
2166 | "children" : [ | |
2167 | { | |
2168 | "info" : { | |
2169 | "DELETE" : { | |
2170 | "description" : "Delete a transport map entry", | |
2171 | "method" : "DELETE", | |
2172 | "name" : "delete", | |
2173 | "parameters" : { | |
2174 | "additionalProperties" : 0, | |
2175 | "properties" : { | |
2176 | "domain" : { | |
2177 | "description" : "Domain name.", | |
2178 | "format" : "transport-domain", | |
2179 | "type" : "string", | |
2180 | "typetext" : "<string>" | |
2181 | } | |
2182 | } | |
2183 | }, | |
2184 | "protected" : 1, | |
2185 | "proxyto" : "master", | |
2186 | "returns" : { | |
2187 | "type" : "null" | |
2188 | } | |
2189 | }, | |
2190 | "GET" : { | |
2191 | "description" : "Read transport map entry.", | |
2192 | "method" : "GET", | |
2193 | "name" : "read", | |
2194 | "parameters" : { | |
2195 | "additionalProperties" : 0, | |
2196 | "properties" : { | |
2197 | "domain" : { | |
2198 | "description" : "Domain name.", | |
2199 | "format" : "transport-domain", | |
2200 | "type" : "string", | |
2201 | "typetext" : "<string>" | |
2202 | } | |
2203 | } | |
2204 | }, | |
2205 | "proxyto" : "master", | |
2206 | "returns" : { | |
2207 | "properties" : { | |
2208 | "comment" : { | |
2209 | "type" : "string" | |
2210 | }, | |
2211 | "domain" : { | |
2212 | "type" : "string" | |
410dc2c9 | 2213 | }, |
eff914dc DM |
2214 | "host" : { |
2215 | "type" : "string" | |
2216 | }, | |
2217 | "port" : { | |
2218 | "type" : "integer" | |
2219 | }, | |
2220 | "use_mx" : { | |
2221 | "type" : "boolean" | |
2222 | } | |
2223 | }, | |
2224 | "type" : "object" | |
2225 | } | |
2226 | }, | |
2227 | "PUT" : { | |
2228 | "description" : "Update transport map entry.", | |
2229 | "method" : "PUT", | |
2230 | "name" : "write", | |
2231 | "parameters" : { | |
2232 | "additionalProperties" : 0, | |
2233 | "properties" : { | |
2234 | "comment" : { | |
2235 | "description" : "Comment.", | |
410dc2c9 DM |
2236 | "optional" : 1, |
2237 | "type" : "string", | |
2238 | "typetext" : "<string>" | |
2239 | }, | |
eff914dc DM |
2240 | "domain" : { |
2241 | "description" : "Domain name.", | |
2242 | "format" : "transport-domain", | |
410dc2c9 DM |
2243 | "type" : "string", |
2244 | "typetext" : "<string>" | |
2245 | }, | |
eff914dc DM |
2246 | "host" : { |
2247 | "description" : "Target host (name or IP address).", | |
2248 | "format" : "address", | |
410dc2c9 DM |
2249 | "optional" : 1, |
2250 | "type" : "string", | |
2251 | "typetext" : "<string>" | |
2252 | }, | |
410dc2c9 | 2253 | "port" : { |
eff914dc | 2254 | "description" : "SMTP port.", |
410dc2c9 DM |
2255 | "maximum" : 65535, |
2256 | "minimum" : 1, | |
2257 | "optional" : 1, | |
2258 | "type" : "integer", | |
2259 | "typetext" : "<integer> (1 - 65535)" | |
2260 | }, | |
eff914dc DM |
2261 | "use_mx" : { |
2262 | "description" : "Enable MX lookups.", | |
410dc2c9 | 2263 | "optional" : 1, |
eff914dc DM |
2264 | "type" : "boolean", |
2265 | "typetext" : "<boolean>" | |
410dc2c9 | 2266 | } |
eff914dc | 2267 | } |
410dc2c9 DM |
2268 | }, |
2269 | "protected" : 1, | |
2270 | "proxyto" : "master", | |
2271 | "returns" : { | |
2272 | "type" : "null" | |
2273 | } | |
2274 | } | |
2275 | }, | |
2276 | "leaf" : 1, | |
eff914dc DM |
2277 | "path" : "/config/transport/{domain}", |
2278 | "text" : "{domain}" | |
410dc2c9 DM |
2279 | } |
2280 | ], | |
2281 | "info" : { | |
2282 | "GET" : { | |
eff914dc | 2283 | "description" : "List transport map entries.", |
410dc2c9 DM |
2284 | "method" : "GET", |
2285 | "name" : "index", | |
2286 | "parameters" : { | |
2287 | "additionalProperties" : 0 | |
2288 | }, | |
410dc2c9 DM |
2289 | "proxyto" : "master", |
2290 | "returns" : { | |
2291 | "items" : { | |
2292 | "properties" : { | |
eff914dc | 2293 | "comment" : { |
410dc2c9 DM |
2294 | "type" : "string" |
2295 | }, | |
eff914dc | 2296 | "domain" : { |
410dc2c9 DM |
2297 | "type" : "string" |
2298 | }, | |
eff914dc | 2299 | "host" : { |
410dc2c9 | 2300 | "type" : "string" |
eff914dc DM |
2301 | }, |
2302 | "port" : { | |
2303 | "type" : "integer" | |
2304 | }, | |
2305 | "use_mx" : { | |
2306 | "type" : "boolean" | |
410dc2c9 DM |
2307 | } |
2308 | }, | |
2309 | "type" : "object" | |
2310 | }, | |
2311 | "links" : [ | |
2312 | { | |
eff914dc | 2313 | "href" : "{id}", |
410dc2c9 DM |
2314 | "rel" : "child" |
2315 | } | |
2316 | ], | |
2317 | "type" : "array" | |
2318 | } | |
2319 | }, | |
2320 | "POST" : { | |
eff914dc | 2321 | "description" : "Add transport map entry.", |
410dc2c9 DM |
2322 | "method" : "POST", |
2323 | "name" : "create", | |
2324 | "parameters" : { | |
2325 | "additionalProperties" : 0, | |
2326 | "properties" : { | |
eff914dc DM |
2327 | "comment" : { |
2328 | "description" : "Comment.", | |
410dc2c9 DM |
2329 | "optional" : 1, |
2330 | "type" : "string", | |
2331 | "typetext" : "<string>" | |
2332 | }, | |
eff914dc DM |
2333 | "domain" : { |
2334 | "description" : "Domain name.", | |
2335 | "format" : "transport-domain", | |
410dc2c9 DM |
2336 | "type" : "string", |
2337 | "typetext" : "<string>" | |
2338 | }, | |
eff914dc DM |
2339 | "host" : { |
2340 | "description" : "Target host (name or IP address).", | |
2341 | "format" : "address", | |
410dc2c9 DM |
2342 | "type" : "string", |
2343 | "typetext" : "<string>" | |
2344 | }, | |
410dc2c9 | 2345 | "port" : { |
eff914dc DM |
2346 | "default" : 25, |
2347 | "description" : "SMTP port.", | |
410dc2c9 DM |
2348 | "maximum" : 65535, |
2349 | "minimum" : 1, | |
2350 | "optional" : 1, | |
2351 | "type" : "integer", | |
2352 | "typetext" : "<integer> (1 - 65535)" | |
2353 | }, | |
eff914dc DM |
2354 | "use_mx" : { |
2355 | "default" : 1, | |
2356 | "description" : "Enable MX lookups.", | |
410dc2c9 | 2357 | "optional" : 1, |
eff914dc DM |
2358 | "type" : "boolean", |
2359 | "typetext" : "<boolean>" | |
410dc2c9 | 2360 | } |
eff914dc | 2361 | } |
410dc2c9 DM |
2362 | }, |
2363 | "protected" : 1, | |
2364 | "proxyto" : "master", | |
2365 | "returns" : { | |
2366 | "type" : "null" | |
2367 | } | |
2368 | } | |
2369 | }, | |
2370 | "leaf" : 0, | |
eff914dc DM |
2371 | "path" : "/config/transport", |
2372 | "text" : "transport" | |
410dc2c9 DM |
2373 | }, |
2374 | { | |
2375 | "children" : [ | |
2376 | { | |
2377 | "info" : { | |
2378 | "DELETE" : { | |
eff914dc | 2379 | "description" : "Delete a truster network", |
410dc2c9 DM |
2380 | "method" : "DELETE", |
2381 | "name" : "delete", | |
2382 | "parameters" : { | |
2383 | "additionalProperties" : 0, | |
2384 | "properties" : { | |
eff914dc DM |
2385 | "cidr" : { |
2386 | "description" : "IPv4 or IPv6 network in CIDR notation.", | |
2387 | "format" : "CIDR", | |
2388 | "type" : "string", | |
2389 | "typetext" : "<string>" | |
2390 | } | |
2391 | } | |
2392 | }, | |
2393 | "protected" : 1, | |
2394 | "proxyto" : "master", | |
2395 | "returns" : { | |
2396 | "type" : "null" | |
2397 | } | |
2398 | }, | |
2399 | "GET" : { | |
2400 | "description" : "Read trusted network data (comment).", | |
2401 | "method" : "GET", | |
2402 | "name" : "read", | |
2403 | "parameters" : { | |
2404 | "additionalProperties" : 0, | |
2405 | "properties" : { | |
2406 | "cidr" : { | |
2407 | "description" : "IPv4 or IPv6 network in CIDR notation.", | |
2408 | "format" : "CIDR", | |
2409 | "type" : "string", | |
2410 | "typetext" : "<string>" | |
2411 | } | |
2412 | } | |
2413 | }, | |
2414 | "proxyto" : "master", | |
2415 | "returns" : { | |
2416 | "properties" : { | |
2417 | "cidr" : { | |
2418 | "type" : "string" | |
2419 | }, | |
2420 | "comment" : { | |
2421 | "type" : "string" | |
2422 | } | |
2423 | }, | |
2424 | "type" : "object" | |
2425 | } | |
2426 | }, | |
2427 | "PUT" : { | |
2428 | "description" : "Update trusted data (comment).", | |
2429 | "method" : "PUT", | |
2430 | "name" : "write", | |
2431 | "parameters" : { | |
2432 | "additionalProperties" : 0, | |
2433 | "properties" : { | |
2434 | "cidr" : { | |
2435 | "description" : "IPv4 or IPv6 network in CIDR notation.", | |
2436 | "type" : "string", | |
2437 | "typetext" : "<string>" | |
2438 | }, | |
2439 | "comment" : { | |
2440 | "description" : "Comment.", | |
410dc2c9 DM |
2441 | "type" : "string", |
2442 | "typetext" : "<string>" | |
2443 | } | |
2444 | } | |
2445 | }, | |
2446 | "protected" : 1, | |
2447 | "proxyto" : "master", | |
2448 | "returns" : { | |
2449 | "type" : "null" | |
2450 | } | |
2451 | } | |
2452 | }, | |
2453 | "leaf" : 1, | |
eff914dc DM |
2454 | "path" : "/config/mynetworks/{cidr}", |
2455 | "text" : "{cidr}" | |
410dc2c9 DM |
2456 | } |
2457 | ], | |
2458 | "info" : { | |
2459 | "GET" : { | |
eff914dc | 2460 | "description" : "List of trusted networks from where SMTP clients are allowed to relay mail through Proxmox Mail Gateway.", |
410dc2c9 DM |
2461 | "method" : "GET", |
2462 | "name" : "index", | |
2463 | "parameters" : { | |
2464 | "additionalProperties" : 0 | |
2465 | }, | |
2466 | "proxyto" : "master", | |
2467 | "returns" : { | |
2468 | "items" : { | |
2469 | "properties" : { | |
eff914dc | 2470 | "cidr" : { |
410dc2c9 DM |
2471 | "type" : "string" |
2472 | } | |
2473 | }, | |
2474 | "type" : "object" | |
2475 | }, | |
2476 | "links" : [ | |
2477 | { | |
eff914dc | 2478 | "href" : "{cide}", |
410dc2c9 DM |
2479 | "rel" : "child" |
2480 | } | |
2481 | ], | |
2482 | "type" : "array" | |
2483 | } | |
2484 | }, | |
2485 | "POST" : { | |
eff914dc | 2486 | "description" : "Add a trusted network.", |
410dc2c9 DM |
2487 | "method" : "POST", |
2488 | "name" : "create", | |
2489 | "parameters" : { | |
2490 | "additionalProperties" : 0, | |
2491 | "properties" : { | |
eff914dc DM |
2492 | "cidr" : { |
2493 | "description" : "IPv4 or IPv6 network in CIDR notation.", | |
2494 | "format" : "CIDR", | |
2495 | "type" : "string", | |
2496 | "typetext" : "<string>" | |
2497 | }, | |
2498 | "comment" : { | |
2499 | "description" : "Comment.", | |
2500 | "optional" : 1, | |
410dc2c9 DM |
2501 | "type" : "string", |
2502 | "typetext" : "<string>" | |
2503 | } | |
2504 | } | |
2505 | }, | |
2506 | "protected" : 1, | |
2507 | "proxyto" : "master", | |
2508 | "returns" : { | |
2509 | "type" : "null" | |
2510 | } | |
2511 | } | |
2512 | }, | |
2513 | "leaf" : 0, | |
eff914dc DM |
2514 | "path" : "/config/mynetworks", |
2515 | "text" : "mynetworks" | |
410dc2c9 DM |
2516 | }, |
2517 | { | |
2518 | "info" : { | |
2519 | "GET" : { | |
2520 | "description" : "Cluster node index.", | |
2521 | "method" : "GET", | |
2522 | "name" : "index", | |
2523 | "parameters" : { | |
2524 | "additionalProperties" : 0 | |
2525 | }, | |
2526 | "returns" : { | |
2527 | "items" : { | |
2528 | "properties" : { | |
2529 | "cid" : { | |
2530 | "type" : "integer" | |
2531 | } | |
2532 | }, | |
2533 | "type" : "object" | |
2534 | }, | |
2535 | "links" : [ | |
2536 | { | |
2537 | "href" : "{cid}", | |
2538 | "rel" : "child" | |
2539 | } | |
2540 | ], | |
2541 | "type" : "array" | |
2542 | } | |
2543 | } | |
2544 | }, | |
2545 | "leaf" : 1, | |
2546 | "path" : "/config/cluster", | |
2547 | "text" : "cluster" | |
2548 | }, | |
2549 | { | |
2550 | "info" : { | |
2551 | "GET" : { | |
2552 | "description" : "Read admin configuration properties.", | |
2553 | "method" : "GET", | |
2554 | "name" : "read_admin_section", | |
2555 | "parameters" : { | |
2556 | "additionalProperties" : 0 | |
2557 | }, | |
2558 | "proxyto" : "master", | |
2559 | "returns" : { | |
2560 | "type" : "object" | |
2561 | } | |
2562 | }, | |
2563 | "PUT" : { | |
2564 | "description" : "Update admin configuration properties.", | |
2565 | "method" : "PUT", | |
2566 | "name" : "update_admin_section", | |
2567 | "parameters" : { | |
2568 | "additionalProperties" : 0, | |
2569 | "properties" : { | |
2570 | "dailyreport" : { | |
2571 | "default" : 1, | |
2572 | "description" : "Send daily reports.", | |
2573 | "optional" : 1, | |
2574 | "type" : "boolean", | |
2575 | "typetext" : "<boolean>" | |
2576 | }, | |
2577 | "delete" : { | |
2578 | "description" : "A list of settings you want to delete.", | |
2579 | "format" : "pve-configid-list", | |
2580 | "maxLength" : 4096, | |
2581 | "optional" : 1, | |
2582 | "type" : "string", | |
2583 | "typetext" : "<string>" | |
2584 | }, | |
2585 | "demo" : { | |
2586 | "default" : 0, | |
2587 | "description" : "Demo mode - do not start SMTP filter.", | |
2588 | "optional" : 1, | |
2589 | "type" : "boolean", | |
2590 | "typetext" : "<boolean>" | |
2591 | }, | |
2592 | "digest" : { | |
2593 | "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", | |
2594 | "maxLength" : 40, | |
2595 | "optional" : 1, | |
2596 | "type" : "string", | |
2597 | "typetext" : "<string>" | |
2598 | }, | |
eff914dc DM |
2599 | "email" : { |
2600 | "default" : "admin@domain.tld", | |
2601 | "description" : "Administrator E-Mail address.", | |
2602 | "format" : "email", | |
2603 | "optional" : 1, | |
2604 | "type" : "string", | |
2605 | "typetext" : "<string>" | |
2606 | }, | |
410dc2c9 DM |
2607 | "proxypassword" : { |
2608 | "description" : "HTTP proxy password.", | |
2609 | "optional" : 1, | |
2610 | "type" : "string", | |
2611 | "typetext" : "<string>" | |
2612 | }, | |
2613 | "proxyport" : { | |
2614 | "default" : 8080, | |
2615 | "description" : "HTTP proxy port.", | |
2616 | "minimum" : 1, | |
2617 | "optional" : 1, | |
2618 | "type" : "integer", | |
2619 | "typetext" : "<integer> (1 - N)" | |
2620 | }, | |
2621 | "proxyserver" : { | |
2622 | "description" : "HTTP proxy server address.", | |
2623 | "optional" : 1, | |
2624 | "type" : "string", | |
2625 | "typetext" : "<string>" | |
2626 | }, | |
2627 | "proxyuser" : { | |
2628 | "description" : "HTTP proxy user name.", | |
2629 | "optional" : 1, | |
2630 | "type" : "string", | |
2631 | "typetext" : "<string>" | |
2632 | } | |
2633 | }, | |
2634 | "type" : "object" | |
2635 | }, | |
2636 | "protected" : 1, | |
2637 | "proxyto" : "master", | |
2638 | "returns" : { | |
2639 | "type" : "null" | |
2640 | } | |
2641 | } | |
2642 | }, | |
2643 | "leaf" : 1, | |
2644 | "path" : "/config/admin", | |
2645 | "text" : "admin" | |
2646 | }, | |
2647 | { | |
2648 | "info" : { | |
2649 | "GET" : { | |
2650 | "description" : "Read clamav configuration properties.", | |
2651 | "method" : "GET", | |
2652 | "name" : "read_clamav_section", | |
2653 | "parameters" : { | |
2654 | "additionalProperties" : 0 | |
2655 | }, | |
2656 | "proxyto" : "master", | |
2657 | "returns" : { | |
2658 | "type" : "object" | |
2659 | } | |
2660 | }, | |
2661 | "PUT" : { | |
2662 | "description" : "Update clamav configuration properties.", | |
2663 | "method" : "PUT", | |
2664 | "name" : "update_clamav_section", | |
2665 | "parameters" : { | |
2666 | "additionalProperties" : 0, | |
2667 | "properties" : { | |
2668 | "archiveblockencrypted" : { | |
2669 | "default" : 0, | |
2670 | "description" : "Wether to block encrypted archives. Mark encrypted archives as viruses.", | |
2671 | "optional" : 1, | |
2672 | "type" : "boolean", | |
2673 | "typetext" : "<boolean>" | |
2674 | }, | |
2675 | "archivemaxfiles" : { | |
2676 | "default" : 1000, | |
2677 | "description" : "Number of files to be scanned within an archive, a document, or any other kind of container. Warning: disabling this limit or setting it too high may result in severe damage to the system.", | |
2678 | "minimum" : 0, | |
2679 | "optional" : 1, | |
2680 | "type" : "integer", | |
2681 | "typetext" : "<integer> (0 - N)" | |
2682 | }, | |
2683 | "archivemaxrec" : { | |
2684 | "default" : 5, | |
2685 | "description" : "Nested archives are scanned recursively, e.g. if a ZIP archive contains a TAR file, all files within it will also be scanned. This options specifies how deeply the process should be continued. Warning: setting this limit too high may result in severe damage to the system.", | |
2686 | "minimum" : 1, | |
2687 | "optional" : 1, | |
2688 | "type" : "integer", | |
2689 | "typetext" : "<integer> (1 - N)" | |
2690 | }, | |
2691 | "archivemaxsize" : { | |
2692 | "default" : 25000000, | |
2693 | "description" : "Files larger than this limit won't be scanned.", | |
2694 | "minimum" : 1000000, | |
2695 | "optional" : 1, | |
2696 | "type" : "integer", | |
2697 | "typetext" : "<integer> (1000000 - N)" | |
2698 | }, | |
2699 | "dbmirror" : { | |
2700 | "default" : "database.clamav.net", | |
2701 | "description" : "ClamAV database mirror server.", | |
2702 | "optional" : 1, | |
2703 | "type" : "string", | |
2704 | "typetext" : "<string>" | |
2705 | }, | |
2706 | "delete" : { | |
2707 | "description" : "A list of settings you want to delete.", | |
2708 | "format" : "pve-configid-list", | |
2709 | "maxLength" : 4096, | |
2710 | "optional" : 1, | |
2711 | "type" : "string", | |
2712 | "typetext" : "<string>" | |
2713 | }, | |
2714 | "digest" : { | |
2715 | "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", | |
2716 | "maxLength" : 40, | |
2717 | "optional" : 1, | |
2718 | "type" : "string", | |
2719 | "typetext" : "<string>" | |
2720 | }, | |
2721 | "maxcccount" : { | |
2722 | "default" : 0, | |
2723 | "description" : "This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.", | |
2724 | "minimum" : 0, | |
2725 | "optional" : 1, | |
2726 | "type" : "integer", | |
2727 | "typetext" : "<integer> (0 - N)" | |
2728 | }, | |
2729 | "maxscansize" : { | |
2730 | "default" : 100000000, | |
2731 | "description" : "Sets the maximum amount of data to be scanned for each input file.", | |
2732 | "minimum" : 1000000, | |
2733 | "optional" : 1, | |
2734 | "type" : "integer", | |
2735 | "typetext" : "<integer> (1000000 - N)" | |
2736 | } | |
2737 | }, | |
2738 | "type" : "object" | |
2739 | }, | |
2740 | "protected" : 1, | |
2741 | "proxyto" : "master", | |
2742 | "returns" : { | |
2743 | "type" : "null" | |
2744 | } | |
2745 | } | |
2746 | }, | |
2747 | "leaf" : 1, | |
2748 | "path" : "/config/clamav", | |
2749 | "text" : "clamav" | |
2750 | }, | |
2751 | { | |
2752 | "info" : { | |
2753 | "GET" : { | |
2754 | "description" : "Read mail configuration properties.", | |
2755 | "method" : "GET", | |
2756 | "name" : "read_mail_section", | |
2757 | "parameters" : { | |
2758 | "additionalProperties" : 0 | |
2759 | }, | |
2760 | "proxyto" : "master", | |
2761 | "returns" : { | |
2762 | "type" : "object" | |
2763 | } | |
2764 | }, | |
2765 | "PUT" : { | |
2766 | "description" : "Update mail configuration properties.", | |
2767 | "method" : "PUT", | |
2768 | "name" : "update_mail_section", | |
2769 | "parameters" : { | |
2770 | "additionalProperties" : 0, | |
2771 | "properties" : { | |
2772 | "banner" : { | |
2773 | "default" : "ESMTP Proxmox", | |
2774 | "description" : "ESMTP banner.", | |
2775 | "maxLength" : 1024, | |
2776 | "optional" : 1, | |
2777 | "type" : "string", | |
2778 | "typetext" : "<string>" | |
2779 | }, | |
2780 | "conn_count_limit" : { | |
2781 | "default" : 50, | |
2782 | "description" : "How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.", | |
2783 | "minimum" : 0, | |
2784 | "optional" : 1, | |
2785 | "type" : "integer", | |
2786 | "typetext" : "<integer> (0 - N)" | |
2787 | }, | |
2788 | "conn_rate_limit" : { | |
2789 | "default" : 0, | |
2790 | "description" : "The maximal number of connection attempts any client is allowed to make to this service per minute. To disable this feature, specify a limit of 0.", | |
2791 | "minimum" : 0, | |
2792 | "optional" : 1, | |
2793 | "type" : "integer", | |
2794 | "typetext" : "<integer> (0 - N)" | |
2795 | }, | |
2796 | "delete" : { | |
2797 | "description" : "A list of settings you want to delete.", | |
2798 | "format" : "pve-configid-list", | |
2799 | "maxLength" : 4096, | |
2800 | "optional" : 1, | |
2801 | "type" : "string", | |
2802 | "typetext" : "<string>" | |
2803 | }, | |
2804 | "digest" : { | |
2805 | "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", | |
2806 | "maxLength" : 40, | |
2807 | "optional" : 1, | |
2808 | "type" : "string", | |
2809 | "typetext" : "<string>" | |
2810 | }, | |
2811 | "dnsbl_sites" : { | |
2812 | "description" : "Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).", | |
2813 | "optional" : 1, | |
2814 | "type" : "string", | |
2815 | "typetext" : "<string>" | |
2816 | }, | |
2817 | "dwarning" : { | |
2818 | "default" : 4, | |
2819 | "description" : "SMTP delay warning time (in hours).", | |
2820 | "minimum" : 0, | |
2821 | "optional" : 1, | |
2822 | "type" : "integer", | |
2823 | "typetext" : "<integer> (0 - N)" | |
2824 | }, | |
eff914dc DM |
2825 | "ext_port" : { |
2826 | "default" : 26, | |
2827 | "description" : "SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.", | |
2828 | "maximum" : 65535, | |
2829 | "minimum" : 1, | |
2830 | "optional" : 1, | |
2831 | "type" : "integer", | |
2832 | "typetext" : "<integer> (1 - 65535)" | |
2833 | }, | |
410dc2c9 DM |
2834 | "greylist" : { |
2835 | "default" : 1, | |
2836 | "description" : "Use Greylisting.", | |
2837 | "optional" : 1, | |
2838 | "type" : "boolean", | |
2839 | "typetext" : "<boolean>" | |
2840 | }, | |
2841 | "helotests" : { | |
2842 | "default" : 0, | |
2843 | "description" : "Use SMTP HELO tests.", | |
2844 | "optional" : 1, | |
2845 | "type" : "boolean", | |
2846 | "typetext" : "<boolean>" | |
2847 | }, | |
2848 | "hide_received" : { | |
2849 | "default" : 0, | |
2850 | "description" : "Hide received header in outgoing mails.", | |
2851 | "optional" : 1, | |
2852 | "type" : "boolean", | |
2853 | "typetext" : "<boolean>" | |
2854 | }, | |
eff914dc DM |
2855 | "int_port" : { |
2856 | "default" : 25, | |
2857 | "description" : "SMTP port number for outgoing mail (trusted).", | |
2858 | "maximum" : 65535, | |
2859 | "minimum" : 1, | |
2860 | "optional" : 1, | |
2861 | "type" : "integer", | |
2862 | "typetext" : "<integer> (1 - 65535)" | |
2863 | }, | |
410dc2c9 DM |
2864 | "max_filters" : { |
2865 | "default" : 15, | |
2866 | "description" : "Maximum number of pmg-smtp-filter processes.", | |
2867 | "maximum" : 40, | |
2868 | "minimum" : 3, | |
2869 | "optional" : 1, | |
2870 | "type" : "integer", | |
2871 | "typetext" : "<integer> (3 - 40)" | |
2872 | }, | |
2873 | "max_policy" : { | |
2874 | "default" : 5, | |
2875 | "description" : "Maximum number of pmgpolicy processes.", | |
2876 | "maximum" : 10, | |
2877 | "minimum" : 2, | |
2878 | "optional" : 1, | |
2879 | "type" : "integer", | |
2880 | "typetext" : "<integer> (2 - 10)" | |
2881 | }, | |
2882 | "max_smtpd_in" : { | |
2883 | "default" : 99, | |
2884 | "description" : "Maximum number of SMTP daemon processes (in).", | |
2885 | "maximum" : 100, | |
2886 | "minimum" : 3, | |
2887 | "optional" : 1, | |
2888 | "type" : "integer", | |
2889 | "typetext" : "<integer> (3 - 100)" | |
2890 | }, | |
2891 | "max_smtpd_out" : { | |
2892 | "default" : 99, | |
2893 | "description" : "Maximum number of SMTP daemon processes (out).", | |
2894 | "maximum" : 100, | |
2895 | "minimum" : 3, | |
2896 | "optional" : 1, | |
2897 | "type" : "integer", | |
2898 | "typetext" : "<integer> (3 - 100)" | |
2899 | }, | |
2900 | "maxsize" : { | |
2901 | "default" : 10485760, | |
2902 | "description" : "Maximum email size. Larger mails are rejected.", | |
2903 | "minimum" : 1024, | |
2904 | "optional" : 1, | |
2905 | "type" : "integer", | |
2906 | "typetext" : "<integer> (1024 - N)" | |
2907 | }, | |
2908 | "message_rate_limit" : { | |
2909 | "default" : 0, | |
2910 | "description" : "The maximal number of message delivery requests that any client is allowed to make to this service per minute.To disable this feature, specify a limit of 0.", | |
2911 | "minimum" : 0, | |
2912 | "optional" : 1, | |
2913 | "type" : "integer", | |
2914 | "typetext" : "<integer> (0 - N)" | |
2915 | }, | |
2916 | "rejectunknown" : { | |
2917 | "default" : 0, | |
2918 | "description" : "Reject unknown clients.", | |
2919 | "optional" : 1, | |
2920 | "type" : "boolean", | |
2921 | "typetext" : "<boolean>" | |
2922 | }, | |
2923 | "rejectunknownsender" : { | |
2924 | "default" : 0, | |
2925 | "description" : "Reject unknown senders.", | |
2926 | "optional" : 1, | |
2927 | "type" : "boolean", | |
2928 | "typetext" : "<boolean>" | |
2929 | }, | |
2930 | "relay" : { | |
2931 | "description" : "The default mail delivery transport (incoming mails).", | |
eff914dc | 2932 | "format" : "address", |
410dc2c9 DM |
2933 | "optional" : 1, |
2934 | "type" : "string", | |
2935 | "typetext" : "<string>" | |
2936 | }, | |
2937 | "relaynomx" : { | |
2938 | "default" : 0, | |
2939 | "description" : "Disable MX lookups for default relay.", | |
2940 | "optional" : 1, | |
2941 | "type" : "boolean", | |
2942 | "typetext" : "<boolean>" | |
2943 | }, | |
2944 | "relayport" : { | |
2945 | "default" : 25, | |
2946 | "description" : "SMTP port number for relay host.", | |
2947 | "maximum" : 65535, | |
2948 | "minimum" : 1, | |
2949 | "optional" : 1, | |
2950 | "type" : "integer", | |
2951 | "typetext" : "<integer> (1 - 65535)" | |
2952 | }, | |
eff914dc DM |
2953 | "smarthost" : { |
2954 | "description" : "When set, all outgoing mails are deliverd to the specified smarthost.", | |
2955 | "format" : "address", | |
2956 | "optional" : 1, | |
2957 | "type" : "string", | |
2958 | "typetext" : "<string>" | |
2959 | }, | |
410dc2c9 DM |
2960 | "spf" : { |
2961 | "default" : 1, | |
2962 | "description" : "Use Sender Policy Framework.", | |
2963 | "optional" : 1, | |
2964 | "type" : "boolean", | |
2965 | "typetext" : "<boolean>" | |
2966 | }, | |
2967 | "tls" : { | |
2968 | "default" : 0, | |
eff914dc DM |
2969 | "description" : "Enable TLS.", |
2970 | "optional" : 1, | |
2971 | "type" : "boolean", | |
2972 | "typetext" : "<boolean>" | |
2973 | }, | |
2974 | "tlsheader" : { | |
2975 | "default" : 0, | |
2976 | "description" : "Add TLS received header.", | |
2977 | "optional" : 1, | |
2978 | "type" : "boolean", | |
2979 | "typetext" : "<boolean>" | |
2980 | }, | |
2981 | "tlslog" : { | |
2982 | "default" : 0, | |
2983 | "description" : "Enable TLS Logging.", | |
410dc2c9 DM |
2984 | "optional" : 1, |
2985 | "type" : "boolean", | |
2986 | "typetext" : "<boolean>" | |
2987 | }, | |
2988 | "use_rbl" : { | |
2989 | "default" : 1, | |
2990 | "description" : "Use Realtime Blacklists.", | |
2991 | "optional" : 1, | |
2992 | "type" : "boolean", | |
2993 | "typetext" : "<boolean>" | |
2994 | }, | |
2995 | "verifyreceivers" : { | |
eff914dc DM |
2996 | "description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.", |
2997 | "enum" : [ | |
2998 | "450", | |
2999 | "550" | |
3000 | ], | |
410dc2c9 | 3001 | "optional" : 1, |
eff914dc | 3002 | "type" : "string" |
410dc2c9 DM |
3003 | } |
3004 | }, | |
3005 | "type" : "object" | |
3006 | }, | |
3007 | "protected" : 1, | |
3008 | "proxyto" : "master", | |
3009 | "returns" : { | |
3010 | "type" : "null" | |
3011 | } | |
3012 | } | |
3013 | }, | |
3014 | "leaf" : 1, | |
3015 | "path" : "/config/mail", | |
3016 | "text" : "mail" | |
3017 | }, | |
3018 | { | |
3019 | "info" : { | |
3020 | "GET" : { | |
3021 | "description" : "Read spam configuration properties.", | |
3022 | "method" : "GET", | |
3023 | "name" : "read_spam_section", | |
3024 | "parameters" : { | |
3025 | "additionalProperties" : 0 | |
3026 | }, | |
3027 | "proxyto" : "master", | |
3028 | "returns" : { | |
3029 | "type" : "object" | |
3030 | } | |
3031 | }, | |
3032 | "PUT" : { | |
3033 | "description" : "Update spam configuration properties.", | |
3034 | "method" : "PUT", | |
3035 | "name" : "update_spam_section", | |
3036 | "parameters" : { | |
3037 | "additionalProperties" : 0, | |
3038 | "properties" : { | |
3039 | "bounce_score" : { | |
3040 | "default" : 0, | |
3041 | "description" : "Additional score for bounce mails.", | |
3042 | "maximum" : 1000, | |
3043 | "minimum" : 0, | |
3044 | "optional" : 1, | |
3045 | "type" : "integer", | |
3046 | "typetext" : "<integer> (0 - 1000)" | |
3047 | }, | |
3048 | "delete" : { | |
3049 | "description" : "A list of settings you want to delete.", | |
3050 | "format" : "pve-configid-list", | |
3051 | "maxLength" : 4096, | |
3052 | "optional" : 1, | |
3053 | "type" : "string", | |
3054 | "typetext" : "<string>" | |
3055 | }, | |
3056 | "digest" : { | |
3057 | "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.", | |
3058 | "maxLength" : 40, | |
3059 | "optional" : 1, | |
3060 | "type" : "string", | |
3061 | "typetext" : "<string>" | |
3062 | }, | |
3063 | "languages" : { | |
3064 | "default" : "all", | |
3065 | "description" : "This option is used to specify which languages are considered OK for incoming mail.", | |
3066 | "optional" : 1, | |
3067 | "pattern" : "(all|([a-z][a-z])+( ([a-z][a-z])+)*)", | |
3068 | "type" : "string" | |
3069 | }, | |
3070 | "maxspamsize" : { | |
3071 | "default" : 204800, | |
3072 | "description" : "Maximum size of spam messages in bytes.", | |
3073 | "minimum" : 64, | |
3074 | "optional" : 1, | |
3075 | "type" : "integer", | |
3076 | "typetext" : "<integer> (64 - N)" | |
3077 | }, | |
3078 | "rbl_checks" : { | |
3079 | "default" : 1, | |
3080 | "description" : "Enable real time blacklists (RBL) checks.", | |
3081 | "optional" : 1, | |
3082 | "type" : "boolean", | |
3083 | "typetext" : "<boolean>" | |
3084 | }, | |
3085 | "use_awl" : { | |
3086 | "default" : 1, | |
3087 | "description" : "Use the Auto-Whitelist plugin.", | |
3088 | "optional" : 1, | |
3089 | "type" : "boolean", | |
3090 | "typetext" : "<boolean>" | |
3091 | }, | |
3092 | "use_bayes" : { | |
3093 | "default" : 1, | |
3094 | "description" : "Whether to use the naive-Bayesian-style classifier.", | |
3095 | "optional" : 1, | |
3096 | "type" : "boolean", | |
3097 | "typetext" : "<boolean>" | |
3098 | }, | |
3099 | "use_ocr" : { | |
3100 | "default" : 0, | |
3101 | "description" : "Enable OCR to scan pictures.", | |
3102 | "optional" : 1, | |
3103 | "type" : "boolean", | |
3104 | "typetext" : "<boolean>" | |
3105 | }, | |
3106 | "use_razor" : { | |
3107 | "default" : 1, | |
3108 | "description" : "Whether to use Razor2, if it is available.", | |
3109 | "optional" : 1, | |
3110 | "type" : "boolean", | |
3111 | "typetext" : "<boolean>" | |
3112 | }, | |
3113 | "wl_bounce_relays" : { | |
3114 | "description" : "Whitelist legitimate bounce relays.", | |
3115 | "optional" : 1, | |
3116 | "type" : "string", | |
3117 | "typetext" : "<string>" | |
3118 | } | |
3119 | }, | |
3120 | "type" : "object" | |
3121 | }, | |
3122 | "protected" : 1, | |
3123 | "proxyto" : "master", | |
3124 | "returns" : { | |
3125 | "type" : "null" | |
3126 | } | |
3127 | } | |
3128 | }, | |
3129 | "leaf" : 1, | |
3130 | "path" : "/config/spam", | |
3131 | "text" : "spam" | |
3132 | } | |
3133 | ], | |
3134 | "info" : { | |
3135 | "GET" : { | |
3136 | "description" : "Directory index.", | |
3137 | "method" : "GET", | |
3138 | "name" : "index", | |
3139 | "parameters" : { | |
3140 | "additionalProperties" : 0 | |
3141 | }, | |
3142 | "returns" : { | |
3143 | "items" : { | |
3144 | "properties" : { | |
3145 | "section" : { | |
3146 | "type" : "string" | |
3147 | } | |
3148 | }, | |
3149 | "type" : "object" | |
3150 | }, | |
3151 | "links" : [ | |
3152 | { | |
3153 | "href" : "{section}", | |
3154 | "rel" : "child" | |
3155 | } | |
3156 | ], | |
3157 | "type" : "array" | |
3158 | } | |
3159 | } | |
3160 | }, | |
3161 | "leaf" : 0, | |
3162 | "path" : "/config", | |
3163 | "text" : "config" | |
3164 | }, | |
3165 | { | |
3166 | "children" : [ | |
3167 | { | |
3168 | "children" : [ | |
3169 | { | |
3170 | "children" : [ | |
3171 | { | |
3172 | "info" : { | |
3173 | "DELETE" : { | |
3174 | "description" : "Delete network device configuration", | |
3175 | "method" : "DELETE", | |
3176 | "name" : "delete_network", | |
3177 | "parameters" : { | |
3178 | "additionalProperties" : 0, | |
3179 | "properties" : { | |
3180 | "iface" : { | |
3181 | "description" : "Network interface name.", | |
3182 | "format" : "pve-iface", | |
3183 | "maxLength" : 20, | |
3184 | "minLength" : 2, | |
3185 | "type" : "string", | |
3186 | "typetext" : "<string>" | |
3187 | }, | |
3188 | "node" : { | |
3189 | "description" : "The cluster node name.", | |
3190 | "format" : "pve-node", | |
3191 | "type" : "string", | |
3192 | "typetext" : "<string>" | |
3193 | } | |
3194 | } | |
3195 | }, | |
3196 | "protected" : 1, | |
3197 | "proxyto" : "node", | |
3198 | "returns" : { | |
3199 | "type" : "null" | |
3200 | } | |
3201 | }, | |
3202 | "GET" : { | |
3203 | "description" : "Read network device configuration", | |
3204 | "method" : "GET", | |
3205 | "name" : "network_config", | |
3206 | "parameters" : { | |
3207 | "additionalProperties" : 0, | |
3208 | "properties" : { | |
3209 | "iface" : { | |
3210 | "description" : "Network interface name.", | |
3211 | "format" : "pve-iface", | |
3212 | "maxLength" : 20, | |
3213 | "minLength" : 2, | |
3214 | "type" : "string", | |
3215 | "typetext" : "<string>" | |
3216 | }, | |
3217 | "node" : { | |
3218 | "description" : "The cluster node name.", | |
3219 | "format" : "pve-node", | |
3220 | "type" : "string", | |
3221 | "typetext" : "<string>" | |
3222 | } | |
3223 | } | |
3224 | }, | |
3225 | "proxyto" : "node", | |
3226 | "returns" : { | |
3227 | "properties" : { | |
3228 | "method" : { | |
3229 | "type" : "string" | |
3230 | }, | |
3231 | "type" : { | |
3232 | "type" : "string" | |
3233 | } | |
3234 | }, | |
3235 | "type" : "object" | |
3236 | } | |
3237 | }, | |
3238 | "PUT" : { | |
3239 | "description" : "Update network device configuration", | |
3240 | "method" : "PUT", | |
3241 | "name" : "update_network", | |
3242 | "parameters" : { | |
3243 | "additionalProperties" : 0, | |
3244 | "properties" : { | |
3245 | "address" : { | |
3246 | "description" : "IP address.", | |
3247 | "format" : "ipv4", | |
3248 | "optional" : 1, | |
3249 | "requires" : "netmask", | |
3250 | "type" : "string", | |
3251 | "typetext" : "<string>" | |
3252 | }, | |
3253 | "address6" : { | |
3254 | "description" : "IP address.", | |
3255 | "format" : "ipv6", | |
3256 | "optional" : 1, | |
3257 | "requires" : "netmask6", | |
3258 | "type" : "string", | |
3259 | "typetext" : "<string>" | |
3260 | }, | |
3261 | "autostart" : { | |
3262 | "description" : "Automatically start interface on boot.", | |
3263 | "optional" : 1, | |
3264 | "type" : "boolean", | |
3265 | "typetext" : "<boolean>" | |
3266 | }, | |
3267 | "bond_mode" : { | |
3268 | "description" : "Bonding mode.", | |
3269 | "enum" : [ | |
3270 | "balance-rr", | |
3271 | "active-backup", | |
3272 | "balance-xor", | |
3273 | "broadcast", | |
3274 | "802.3ad", | |
3275 | "balance-tlb", | |
3276 | "balance-alb", | |
3277 | "balance-slb", | |
3278 | "lacp-balance-slb", | |
3279 | "lacp-balance-tcp" | |
3280 | ], | |
3281 | "optional" : 1, | |
3282 | "type" : "string" | |
3283 | }, | |
3284 | "bond_xmit_hash_policy" : { | |
3285 | "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", | |
3286 | "enum" : [ | |
3287 | "layer2", | |
3288 | "layer2+3", | |
3289 | "layer3+4" | |
3290 | ], | |
3291 | "optional" : 1, | |
3292 | "type" : "string" | |
3293 | }, | |
3294 | "bridge_ports" : { | |
3295 | "description" : "Specify the iterfaces you want to add to your bridge.", | |
3296 | "format" : "pve-iface-list", | |
3297 | "optional" : 1, | |
3298 | "type" : "string", | |
3299 | "typetext" : "<string>" | |
3300 | }, | |
3301 | "bridge_vlan_aware" : { | |
3302 | "description" : "Enable bridge vlan support.", | |
3303 | "optional" : 1, | |
3304 | "type" : "boolean", | |
3305 | "typetext" : "<boolean>" | |
3306 | }, | |
3307 | "comments" : { | |
3308 | "description" : "Comments", | |
3309 | "optional" : 1, | |
3310 | "type" : "string", | |
3311 | "typetext" : "<string>" | |
3312 | }, | |
3313 | "comments6" : { | |
3314 | "description" : "Comments", | |
3315 | "optional" : 1, | |
3316 | "type" : "string", | |
3317 | "typetext" : "<string>" | |
3318 | }, | |
3319 | "delete" : { | |
3320 | "description" : "A list of settings you want to delete.", | |
3321 | "format" : "pve-configid-list", | |
3322 | "optional" : 1, | |
3323 | "type" : "string", | |
3324 | "typetext" : "<string>" | |
3325 | }, | |
3326 | "gateway" : { | |
3327 | "description" : "Default gateway address.", | |
3328 | "format" : "ipv4", | |
3329 | "optional" : 1, | |
3330 | "type" : "string", | |
3331 | "typetext" : "<string>" | |
3332 | }, | |
3333 | "gateway6" : { | |
3334 | "description" : "Default ipv6 gateway address.", | |
3335 | "format" : "ipv6", | |
3336 | "optional" : 1, | |
3337 | "type" : "string", | |
3338 | "typetext" : "<string>" | |
3339 | }, | |
3340 | "iface" : { | |
3341 | "description" : "Network interface name.", | |
3342 | "format" : "pve-iface", | |
3343 | "maxLength" : 20, | |
3344 | "minLength" : 2, | |
3345 | "type" : "string", | |
3346 | "typetext" : "<string>" | |
3347 | }, | |
3348 | "netmask" : { | |
3349 | "description" : "Network mask.", | |
3350 | "format" : "ipv4mask", | |
3351 | "optional" : 1, | |
3352 | "requires" : "address", | |
3353 | "type" : "string", | |
3354 | "typetext" : "<string>" | |
3355 | }, | |
3356 | "netmask6" : { | |
3357 | "description" : "Network mask.", | |
3358 | "maximum" : 128, | |
3359 | "minimum" : 0, | |
3360 | "optional" : 1, | |
3361 | "requires" : "address6", | |
3362 | "type" : "integer", | |
3363 | "typetext" : "<integer> (0 - 128)" | |
3364 | }, | |
3365 | "node" : { | |
3366 | "description" : "The cluster node name.", | |
3367 | "format" : "pve-node", | |
3368 | "type" : "string", | |
3369 | "typetext" : "<string>" | |
3370 | }, | |
3371 | "ovs_bonds" : { | |
3372 | "description" : "Specify the interfaces used by the bonding device.", | |
3373 | "format" : "pve-iface-list", | |
3374 | "optional" : 1, | |
3375 | "type" : "string", | |
3376 | "typetext" : "<string>" | |
3377 | }, | |
3378 | "ovs_bridge" : { | |
3379 | "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", | |
3380 | "format" : "pve-iface", | |
3381 | "optional" : 1, | |
3382 | "type" : "string", | |
3383 | "typetext" : "<string>" | |
3384 | }, | |
3385 | "ovs_options" : { | |
3386 | "description" : "OVS interface options.", | |
3387 | "maxLength" : 1024, | |
3388 | "optional" : 1, | |
3389 | "type" : "string", | |
3390 | "typetext" : "<string>" | |
3391 | }, | |
3392 | "ovs_ports" : { | |
3393 | "description" : "Specify the iterfaces you want to add to your bridge.", | |
3394 | "format" : "pve-iface-list", | |
3395 | "optional" : 1, | |
3396 | "type" : "string", | |
3397 | "typetext" : "<string>" | |
3398 | }, | |
3399 | "ovs_tag" : { | |
3400 | "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", | |
3401 | "maximum" : 4094, | |
3402 | "minimum" : 1, | |
3403 | "optional" : 1, | |
3404 | "type" : "integer", | |
3405 | "typetext" : "<integer> (1 - 4094)" | |
3406 | }, | |
3407 | "slaves" : { | |
3408 | "description" : "Specify the interfaces used by the bonding device.", | |
3409 | "format" : "pve-iface-list", | |
3410 | "optional" : 1, | |
3411 | "type" : "string", | |
3412 | "typetext" : "<string>" | |
3413 | }, | |
3414 | "type" : { | |
3415 | "description" : "Network interface type", | |
3416 | "enum" : [ | |
3417 | "bridge", | |
3418 | "bond", | |
3419 | "eth", | |
3420 | "alias", | |
3421 | "vlan", | |
3422 | "OVSBridge", | |
3423 | "OVSBond", | |
3424 | "OVSPort", | |
3425 | "OVSIntPort", | |
3426 | "unknown" | |
3427 | ], | |
3428 | "type" : "string" | |
3429 | } | |
3430 | } | |
3431 | }, | |
3432 | "protected" : 1, | |
3433 | "proxyto" : "node", | |
3434 | "returns" : { | |
3435 | "type" : "null" | |
3436 | } | |
3437 | } | |
3438 | }, | |
3439 | "leaf" : 1, | |
3440 | "path" : "/nodes/{node}/network/{iface}", | |
3441 | "text" : "{iface}" | |
3442 | } | |
3443 | ], | |
3444 | "info" : { | |
3445 | "DELETE" : { | |
3446 | "description" : "Revert network configuration changes.", | |
3447 | "method" : "DELETE", | |
3448 | "name" : "revert_network_changes", | |
3449 | "parameters" : { | |
3450 | "additionalProperties" : 0, | |
3451 | "properties" : { | |
3452 | "node" : { | |
3453 | "description" : "The cluster node name.", | |
3454 | "format" : "pve-node", | |
3455 | "type" : "string", | |
3456 | "typetext" : "<string>" | |
3457 | } | |
3458 | } | |
3459 | }, | |
3460 | "protected" : 1, | |
3461 | "proxyto" : "node", | |
3462 | "returns" : { | |
3463 | "type" : "null" | |
3464 | } | |
3465 | }, | |
3466 | "GET" : { | |
3467 | "description" : "List available networks", | |
3468 | "method" : "GET", | |
3469 | "name" : "index", | |
3470 | "parameters" : { | |
3471 | "additionalProperties" : 0, | |
3472 | "properties" : { | |
3473 | "node" : { | |
3474 | "description" : "The cluster node name.", | |
3475 | "format" : "pve-node", | |
3476 | "type" : "string", | |
3477 | "typetext" : "<string>" | |
3478 | }, | |
3479 | "type" : { | |
3480 | "description" : "Only list specific interface types.", | |
3481 | "enum" : [ | |
3482 | "bridge", | |
3483 | "bond", | |
3484 | "eth", | |
3485 | "alias", | |
3486 | "vlan", | |
3487 | "OVSBridge", | |
3488 | "OVSBond", | |
3489 | "OVSPort", | |
3490 | "OVSIntPort", | |
3491 | "any_bridge" | |
3492 | ], | |
3493 | "optional" : 1, | |
3494 | "type" : "string" | |
3495 | } | |
3496 | } | |
3497 | }, | |
3498 | "proxyto" : "node", | |
3499 | "returns" : { | |
3500 | "items" : { | |
3501 | "properties" : {}, | |
3502 | "type" : "object" | |
3503 | }, | |
3504 | "links" : [ | |
3505 | { | |
3506 | "href" : "{iface}", | |
3507 | "rel" : "child" | |
3508 | } | |
3509 | ], | |
3510 | "type" : "array" | |
3511 | } | |
3512 | }, | |
3513 | "POST" : { | |
3514 | "description" : "Create network device configuration", | |
3515 | "method" : "POST", | |
3516 | "name" : "create_network", | |
3517 | "parameters" : { | |
3518 | "additionalProperties" : 0, | |
3519 | "properties" : { | |
3520 | "address" : { | |
3521 | "description" : "IP address.", | |
3522 | "format" : "ipv4", | |
3523 | "optional" : 1, | |
3524 | "requires" : "netmask", | |
3525 | "type" : "string", | |
3526 | "typetext" : "<string>" | |
3527 | }, | |
3528 | "address6" : { | |
3529 | "description" : "IP address.", | |
3530 | "format" : "ipv6", | |
3531 | "optional" : 1, | |
3532 | "requires" : "netmask6", | |
3533 | "type" : "string", | |
3534 | "typetext" : "<string>" | |
3535 | }, | |
3536 | "autostart" : { | |
3537 | "description" : "Automatically start interface on boot.", | |
3538 | "optional" : 1, | |
3539 | "type" : "boolean", | |
3540 | "typetext" : "<boolean>" | |
3541 | }, | |
3542 | "bond_mode" : { | |
3543 | "description" : "Bonding mode.", | |
3544 | "enum" : [ | |
3545 | "balance-rr", | |
3546 | "active-backup", | |
3547 | "balance-xor", | |
3548 | "broadcast", | |
3549 | "802.3ad", | |
3550 | "balance-tlb", | |
3551 | "balance-alb", | |
3552 | "balance-slb", | |
3553 | "lacp-balance-slb", | |
3554 | "lacp-balance-tcp" | |
3555 | ], | |
3556 | "optional" : 1, | |
3557 | "type" : "string" | |
3558 | }, | |
3559 | "bond_xmit_hash_policy" : { | |
3560 | "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.", | |
3561 | "enum" : [ | |
3562 | "layer2", | |
3563 | "layer2+3", | |
3564 | "layer3+4" | |
3565 | ], | |
3566 | "optional" : 1, | |
3567 | "type" : "string" | |
3568 | }, | |
3569 | "bridge_ports" : { | |
3570 | "description" : "Specify the iterfaces you want to add to your bridge.", | |
3571 | "format" : "pve-iface-list", | |
3572 | "optional" : 1, | |
3573 | "type" : "string", | |
3574 | "typetext" : "<string>" | |
3575 | }, | |
3576 | "bridge_vlan_aware" : { | |
3577 | "description" : "Enable bridge vlan support.", | |
3578 | "optional" : 1, | |
3579 | "type" : "boolean", | |
3580 | "typetext" : "<boolean>" | |
3581 | }, | |
3582 | "comments" : { | |
3583 | "description" : "Comments", | |
3584 | "optional" : 1, | |
3585 | "type" : "string", | |
3586 | "typetext" : "<string>" | |
3587 | }, | |
3588 | "comments6" : { | |
3589 | "description" : "Comments", | |
3590 | "optional" : 1, | |
3591 | "type" : "string", | |
3592 | "typetext" : "<string>" | |
3593 | }, | |
3594 | "gateway" : { | |
3595 | "description" : "Default gateway address.", | |
3596 | "format" : "ipv4", | |
3597 | "optional" : 1, | |
3598 | "type" : "string", | |
3599 | "typetext" : "<string>" | |
3600 | }, | |
3601 | "gateway6" : { | |
3602 | "description" : "Default ipv6 gateway address.", | |
3603 | "format" : "ipv6", | |
3604 | "optional" : 1, | |
3605 | "type" : "string", | |
3606 | "typetext" : "<string>" | |
3607 | }, | |
3608 | "iface" : { | |
3609 | "description" : "Network interface name.", | |
3610 | "format" : "pve-iface", | |
3611 | "maxLength" : 20, | |
3612 | "minLength" : 2, | |
3613 | "type" : "string", | |
3614 | "typetext" : "<string>" | |
3615 | }, | |
3616 | "netmask" : { | |
3617 | "description" : "Network mask.", | |
3618 | "format" : "ipv4mask", | |
3619 | "optional" : 1, | |
3620 | "requires" : "address", | |
3621 | "type" : "string", | |
3622 | "typetext" : "<string>" | |
3623 | }, | |
3624 | "netmask6" : { | |
3625 | "description" : "Network mask.", | |
3626 | "maximum" : 128, | |
3627 | "minimum" : 0, | |
3628 | "optional" : 1, | |
3629 | "requires" : "address6", | |
3630 | "type" : "integer", | |
3631 | "typetext" : "<integer> (0 - 128)" | |
3632 | }, | |
3633 | "node" : { | |
3634 | "description" : "The cluster node name.", | |
3635 | "format" : "pve-node", | |
3636 | "type" : "string", | |
3637 | "typetext" : "<string>" | |
3638 | }, | |
3639 | "ovs_bonds" : { | |
3640 | "description" : "Specify the interfaces used by the bonding device.", | |
3641 | "format" : "pve-iface-list", | |
3642 | "optional" : 1, | |
3643 | "type" : "string", | |
3644 | "typetext" : "<string>" | |
3645 | }, | |
3646 | "ovs_bridge" : { | |
3647 | "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.", | |
3648 | "format" : "pve-iface", | |
3649 | "optional" : 1, | |
3650 | "type" : "string", | |
3651 | "typetext" : "<string>" | |
3652 | }, | |
3653 | "ovs_options" : { | |
3654 | "description" : "OVS interface options.", | |
3655 | "maxLength" : 1024, | |
3656 | "optional" : 1, | |
3657 | "type" : "string", | |
3658 | "typetext" : "<string>" | |
3659 | }, | |
3660 | "ovs_ports" : { | |
3661 | "description" : "Specify the iterfaces you want to add to your bridge.", | |
3662 | "format" : "pve-iface-list", | |
3663 | "optional" : 1, | |
3664 | "type" : "string", | |
3665 | "typetext" : "<string>" | |
3666 | }, | |
3667 | "ovs_tag" : { | |
3668 | "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)", | |
3669 | "maximum" : 4094, | |
3670 | "minimum" : 1, | |
3671 | "optional" : 1, | |
3672 | "type" : "integer", | |
3673 | "typetext" : "<integer> (1 - 4094)" | |
3674 | }, | |
3675 | "slaves" : { | |
3676 | "description" : "Specify the interfaces used by the bonding device.", | |
3677 | "format" : "pve-iface-list", | |
3678 | "optional" : 1, | |
3679 | "type" : "string", | |
3680 | "typetext" : "<string>" | |
3681 | }, | |
3682 | "type" : { | |
3683 | "description" : "Network interface type", | |
3684 | "enum" : [ | |
3685 | "bridge", | |
3686 | "bond", | |
3687 | "eth", | |
3688 | "alias", | |
3689 | "vlan", | |
3690 | "OVSBridge", | |
3691 | "OVSBond", | |
3692 | "OVSPort", | |
3693 | "OVSIntPort", | |
3694 | "unknown" | |
3695 | ], | |
3696 | "type" : "string" | |
3697 | } | |
3698 | } | |
3699 | }, | |
3700 | "protected" : 1, | |
3701 | "proxyto" : "node", | |
3702 | "returns" : { | |
3703 | "type" : "null" | |
3704 | } | |
3705 | } | |
3706 | }, | |
3707 | "leaf" : 0, | |
3708 | "path" : "/nodes/{node}/network", | |
3709 | "text" : "network" | |
3710 | }, | |
3711 | { | |
3712 | "children" : [ | |
3713 | { | |
3714 | "children" : [ | |
3715 | { | |
3716 | "info" : { | |
3717 | "GET" : { | |
3718 | "description" : "Read task log.", | |
3719 | "method" : "GET", | |
3720 | "name" : "read_task_log", | |
3721 | "parameters" : { | |
3722 | "additionalProperties" : 0, | |
3723 | "properties" : { | |
3724 | "limit" : { | |
3725 | "minimum" : 0, | |
3726 | "optional" : 1, | |
3727 | "type" : "integer", | |
3728 | "typetext" : "<integer> (0 - N)" | |
3729 | }, | |
3730 | "node" : { | |
3731 | "description" : "The cluster node name.", | |
3732 | "format" : "pve-node", | |
3733 | "type" : "string", | |
3734 | "typetext" : "<string>" | |
3735 | }, | |
3736 | "start" : { | |
3737 | "minimum" : 0, | |
3738 | "optional" : 1, | |
3739 | "type" : "integer", | |
3740 | "typetext" : "<integer> (0 - N)" | |
3741 | }, | |
3742 | "upid" : { | |
3743 | "type" : "string", | |
3744 | "typetext" : "<string>" | |
3745 | } | |
3746 | } | |
3747 | }, | |
3748 | "protected" : 1, | |
3749 | "proxyto" : "node", | |
3750 | "returns" : { | |
3751 | "items" : { | |
3752 | "properties" : { | |
3753 | "n" : { | |
3754 | "description" : "Line number", | |
3755 | "type" : "integer" | |
3756 | }, | |
3757 | "t" : { | |
3758 | "description" : "Line text", | |
3759 | "type" : "string" | |
3760 | } | |
3761 | }, | |
3762 | "type" : "object" | |
3763 | }, | |
3764 | "type" : "array" | |
3765 | } | |
3766 | } | |
3767 | }, | |
3768 | "leaf" : 1, | |
3769 | "path" : "/nodes/{node}/tasks/{upid}/log", | |
3770 | "text" : "log" | |
3771 | }, | |
3772 | { | |
3773 | "info" : { | |
3774 | "GET" : { | |
3775 | "description" : "Read task status.", | |
3776 | "method" : "GET", | |
3777 | "name" : "read_task_status", | |
3778 | "parameters" : { | |
3779 | "additionalProperties" : 0, | |
3780 | "properties" : { | |
3781 | "node" : { | |
3782 | "description" : "The cluster node name.", | |
3783 | "format" : "pve-node", | |
3784 | "type" : "string", | |
3785 | "typetext" : "<string>" | |
3786 | }, | |
3787 | "upid" : { | |
3788 | "type" : "string", | |
3789 | "typetext" : "<string>" | |
3790 | } | |
3791 | } | |
3792 | }, | |
3793 | "protected" : 1, | |
3794 | "proxyto" : "node", | |
3795 | "returns" : { | |
3796 | "properties" : { | |
3797 | "pid" : { | |
3798 | "type" : "integer" | |
3799 | }, | |
3800 | "status" : { | |
3801 | "enum" : [ | |
3802 | "running", | |
3803 | "stopped" | |
3804 | ], | |
3805 | "type" : "string" | |
3806 | } | |
3807 | }, | |
3808 | "type" : "object" | |
3809 | } | |
3810 | } | |
3811 | }, | |
3812 | "leaf" : 1, | |
3813 | "path" : "/nodes/{node}/tasks/{upid}/status", | |
3814 | "text" : "status" | |
3815 | } | |
3816 | ], | |
3817 | "info" : { | |
3818 | "DELETE" : { | |
3819 | "description" : "Stop a task.", | |
3820 | "method" : "DELETE", | |
3821 | "name" : "stop_task", | |
3822 | "parameters" : { | |
3823 | "additionalProperties" : 0, | |
3824 | "properties" : { | |
3825 | "node" : { | |
3826 | "description" : "The cluster node name.", | |
3827 | "format" : "pve-node", | |
3828 | "type" : "string", | |
3829 | "typetext" : "<string>" | |
3830 | }, | |
3831 | "upid" : { | |
3832 | "type" : "string", | |
3833 | "typetext" : "<string>" | |
3834 | } | |
3835 | } | |
3836 | }, | |
3837 | "protected" : 1, | |
3838 | "proxyto" : "node", | |
3839 | "returns" : { | |
3840 | "type" : "null" | |
3841 | } | |
3842 | }, | |
3843 | "GET" : { | |
3844 | "description" : "", | |
3845 | "method" : "GET", | |
3846 | "name" : "upid_index", | |
3847 | "parameters" : { | |
3848 | "additionalProperties" : 0, | |
3849 | "properties" : { | |
3850 | "node" : { | |
3851 | "description" : "The cluster node name.", | |
3852 | "format" : "pve-node", | |
3853 | "type" : "string", | |
3854 | "typetext" : "<string>" | |
3855 | }, | |
3856 | "upid" : { | |
3857 | "type" : "string", | |
3858 | "typetext" : "<string>" | |
3859 | } | |
3860 | } | |
3861 | }, | |
3862 | "returns" : { | |
3863 | "items" : { | |
3864 | "properties" : {}, | |
3865 | "type" : "object" | |
3866 | }, | |
3867 | "links" : [ | |
3868 | { | |
3869 | "href" : "{name}", | |
3870 | "rel" : "child" | |
3871 | } | |
3872 | ], | |
3873 | "type" : "array" | |
3874 | } | |
3875 | } | |
3876 | }, | |
3877 | "leaf" : 0, | |
3878 | "path" : "/nodes/{node}/tasks/{upid}", | |
3879 | "text" : "{upid}" | |
3880 | } | |
3881 | ], | |
3882 | "info" : { | |
3883 | "GET" : { | |
3884 | "description" : "Read task list for one node (finished tasks).", | |
3885 | "method" : "GET", | |
3886 | "name" : "node_tasks", | |
3887 | "parameters" : { | |
3888 | "additionalProperties" : 0, | |
3889 | "properties" : { | |
3890 | "errors" : { | |
3891 | "optional" : 1, | |
3892 | "type" : "boolean", | |
3893 | "typetext" : "<boolean>" | |
3894 | }, | |
3895 | "limit" : { | |
3896 | "minimum" : 0, | |
3897 | "optional" : 1, | |
3898 | "type" : "integer", | |
3899 | "typetext" : "<integer> (0 - N)" | |
3900 | }, | |
3901 | "node" : { | |
3902 | "description" : "The cluster node name.", | |
3903 | "format" : "pve-node", | |
3904 | "type" : "string", | |
3905 | "typetext" : "<string>" | |
3906 | }, | |
3907 | "start" : { | |
3908 | "minimum" : 0, | |
3909 | "optional" : 1, | |
3910 | "type" : "integer", | |
3911 | "typetext" : "<integer> (0 - N)" | |
3912 | }, | |
3913 | "userfilter" : { | |
3914 | "optional" : 1, | |
3915 | "type" : "string", | |
3916 | "typetext" : "<string>" | |
3917 | } | |
3918 | } | |
3919 | }, | |
3920 | "proxyto" : "node", | |
3921 | "returns" : { | |
3922 | "items" : { | |
3923 | "properties" : { | |
3924 | "upid" : { | |
3925 | "type" : "string" | |
3926 | } | |
3927 | }, | |
3928 | "type" : "object" | |
3929 | }, | |
3930 | "links" : [ | |
3931 | { | |
3932 | "href" : "{upid}", | |
3933 | "rel" : "child" | |
3934 | } | |
3935 | ], | |
3936 | "type" : "array" | |
3937 | } | |
3938 | } | |
3939 | }, | |
3940 | "leaf" : 0, | |
3941 | "path" : "/nodes/{node}/tasks", | |
3942 | "text" : "tasks" | |
3943 | }, | |
3944 | { | |
3945 | "children" : [ | |
3946 | { | |
3947 | "children" : [ | |
3948 | { | |
3949 | "info" : { | |
3950 | "GET" : { | |
3951 | "description" : "Read service properties", | |
3952 | "method" : "GET", | |
3953 | "name" : "service_state", | |
3954 | "parameters" : { | |
3955 | "additionalProperties" : 0, | |
3956 | "properties" : { | |
3957 | "node" : { | |
3958 | "description" : "The cluster node name.", | |
3959 | "format" : "pve-node", | |
3960 | "type" : "string", | |
3961 | "typetext" : "<string>" | |
3962 | }, | |
3963 | "service" : { | |
3964 | "description" : "Service ID", | |
3965 | "enum" : [ | |
3966 | "pmgproxy", | |
3967 | "pmgdaemon", | |
3968 | "pmg-smtp-filter", | |
3969 | "sshd", | |
3970 | "syslog", | |
3971 | "cron", | |
3972 | "postfix", | |
3973 | "systemd-timesyncd" | |
3974 | ], | |
3975 | "type" : "string" | |
3976 | } | |
3977 | } | |
3978 | }, | |
3979 | "protected" : 1, | |
3980 | "proxyto" : "node", | |
3981 | "returns" : { | |
3982 | "properties" : {}, | |
3983 | "type" : "object" | |
3984 | } | |
3985 | } | |
3986 | }, | |
3987 | "leaf" : 1, | |
3988 | "path" : "/nodes/{node}/services/{service}/state", | |
3989 | "text" : "state" | |
3990 | }, | |
3991 | { | |
3992 | "info" : { | |
3993 | "POST" : { | |
3994 | "description" : "Start service.", | |
3995 | "method" : "POST", | |
3996 | "name" : "service_start", | |
3997 | "parameters" : { | |
3998 | "additionalProperties" : 0, | |
3999 | "properties" : { | |
4000 | "node" : { | |
4001 | "description" : "The cluster node name.", | |
4002 | "format" : "pve-node", | |
4003 | "type" : "string", | |
4004 | "typetext" : "<string>" | |
4005 | }, | |
4006 | "service" : { | |
4007 | "description" : "Service ID", | |
4008 | "enum" : [ | |
4009 | "pmgproxy", | |
4010 | "pmgdaemon", | |
4011 | "pmg-smtp-filter", | |
4012 | "sshd", | |
4013 | "syslog", | |
4014 | "cron", | |
4015 | "postfix", | |
4016 | "systemd-timesyncd" | |
4017 | ], | |
4018 | "type" : "string" | |
4019 | } | |
4020 | } | |
4021 | }, | |
4022 | "protected" : 1, | |
4023 | "proxyto" : "node", | |
4024 | "returns" : { | |
4025 | "type" : "string" | |
4026 | } | |
4027 | } | |
4028 | }, | |
4029 | "leaf" : 1, | |
4030 | "path" : "/nodes/{node}/services/{service}/start", | |
4031 | "text" : "start" | |
4032 | }, | |
4033 | { | |
4034 | "info" : { | |
4035 | "POST" : { | |
4036 | "description" : "Stop service.", | |
4037 | "method" : "POST", | |
4038 | "name" : "service_stop", | |
4039 | "parameters" : { | |
4040 | "additionalProperties" : 0, | |
4041 | "properties" : { | |
4042 | "node" : { | |
4043 | "description" : "The cluster node name.", | |
4044 | "format" : "pve-node", | |
4045 | "type" : "string", | |
4046 | "typetext" : "<string>" | |
4047 | }, | |
4048 | "service" : { | |
4049 | "description" : "Service ID", | |
4050 | "enum" : [ | |
4051 | "pmgproxy", | |
4052 | "pmgdaemon", | |
4053 | "pmg-smtp-filter", | |
4054 | "sshd", | |
4055 | "syslog", | |
4056 | "cron", | |
4057 | "postfix", | |
4058 | "systemd-timesyncd" | |
4059 | ], | |
4060 | "type" : "string" | |
4061 | } | |
4062 | } | |
4063 | }, | |
4064 | "protected" : 1, | |
4065 | "proxyto" : "node", | |
4066 | "returns" : { | |
4067 | "type" : "string" | |
4068 | } | |
4069 | } | |
4070 | }, | |
4071 | "leaf" : 1, | |
4072 | "path" : "/nodes/{node}/services/{service}/stop", | |
4073 | "text" : "stop" | |
4074 | }, | |
4075 | { | |
4076 | "info" : { | |
4077 | "POST" : { | |
4078 | "description" : "Restart service.", | |
4079 | "method" : "POST", | |
4080 | "name" : "service_restart", | |
4081 | "parameters" : { | |
4082 | "additionalProperties" : 0, | |
4083 | "properties" : { | |
4084 | "node" : { | |
4085 | "description" : "The cluster node name.", | |
4086 | "format" : "pve-node", | |
4087 | "type" : "string", | |
4088 | "typetext" : "<string>" | |
4089 | }, | |
4090 | "service" : { | |
4091 | "description" : "Service ID", | |
4092 | "enum" : [ | |
4093 | "pmgproxy", | |
4094 | "pmgdaemon", | |
4095 | "pmg-smtp-filter", | |
4096 | "sshd", | |
4097 | "syslog", | |
4098 | "cron", | |
4099 | "postfix", | |
4100 | "systemd-timesyncd" | |
4101 | ], | |
4102 | "type" : "string" | |
4103 | } | |
4104 | } | |
4105 | }, | |
4106 | "protected" : 1, | |
4107 | "proxyto" : "node", | |
4108 | "returns" : { | |
4109 | "type" : "string" | |
4110 | } | |
4111 | } | |
4112 | }, | |
4113 | "leaf" : 1, | |
4114 | "path" : "/nodes/{node}/services/{service}/restart", | |
4115 | "text" : "restart" | |
4116 | }, | |
4117 | { | |
4118 | "info" : { | |
4119 | "POST" : { | |
4120 | "description" : "Reload service.", | |
4121 | "method" : "POST", | |
4122 | "name" : "service_reload", | |
4123 | "parameters" : { | |
4124 | "additionalProperties" : 0, | |
4125 | "properties" : { | |
4126 | "node" : { | |
4127 | "description" : "The cluster node name.", | |
4128 | "format" : "pve-node", | |
4129 | "type" : "string", | |
4130 | "typetext" : "<string>" | |
4131 | }, | |
4132 | "service" : { | |
4133 | "description" : "Service ID", | |
4134 | "enum" : [ | |
4135 | "pmgproxy", | |
4136 | "pmgdaemon", | |
4137 | "pmg-smtp-filter", | |
4138 | "sshd", | |
4139 | "syslog", | |
4140 | "cron", | |
4141 | "postfix", | |
4142 | "systemd-timesyncd" | |
4143 | ], | |
4144 | "type" : "string" | |
4145 | } | |
4146 | } | |
4147 | }, | |
4148 | "protected" : 1, | |
4149 | "proxyto" : "node", | |
4150 | "returns" : { | |
4151 | "type" : "string" | |
4152 | } | |
4153 | } | |
4154 | }, | |
4155 | "leaf" : 1, | |
4156 | "path" : "/nodes/{node}/services/{service}/reload", | |
4157 | "text" : "reload" | |
4158 | } | |
4159 | ], | |
4160 | "info" : { | |
4161 | "GET" : { | |
4162 | "description" : "Directory index", | |
4163 | "method" : "GET", | |
4164 | "name" : "srvcmdidx", | |
4165 | "parameters" : { | |
4166 | "additionalProperties" : 0, | |
4167 | "properties" : { | |
4168 | "node" : { | |
4169 | "description" : "The cluster node name.", | |
4170 | "format" : "pve-node", | |
4171 | "type" : "string", | |
4172 | "typetext" : "<string>" | |
4173 | }, | |
4174 | "service" : { | |
4175 | "description" : "Service ID", | |
4176 | "enum" : [ | |
4177 | "pmgproxy", | |
4178 | "pmgdaemon", | |
4179 | "pmg-smtp-filter", | |
4180 | "sshd", | |
4181 | "syslog", | |
4182 | "cron", | |
4183 | "postfix", | |
4184 | "systemd-timesyncd" | |
4185 | ], | |
4186 | "type" : "string" | |
4187 | } | |
4188 | } | |
4189 | }, | |
4190 | "returns" : { | |
4191 | "items" : { | |
4192 | "properties" : { | |
4193 | "subdir" : { | |
4194 | "type" : "string" | |
4195 | } | |
4196 | }, | |
4197 | "type" : "object" | |
4198 | }, | |
4199 | "links" : [ | |
4200 | { | |
4201 | "href" : "{subdir}", | |
4202 | "rel" : "child" | |
4203 | } | |
4204 | ], | |
4205 | "type" : "array" | |
4206 | } | |
4207 | } | |
4208 | }, | |
4209 | "leaf" : 0, | |
4210 | "path" : "/nodes/{node}/services/{service}", | |
4211 | "text" : "{service}" | |
4212 | } | |
4213 | ], | |
4214 | "info" : { | |
4215 | "GET" : { | |
4216 | "description" : "Service list.", | |
4217 | "method" : "GET", | |
4218 | "name" : "index", | |
4219 | "parameters" : { | |
4220 | "additionalProperties" : 0, | |
4221 | "properties" : { | |
4222 | "node" : { | |
4223 | "description" : "The cluster node name.", | |
4224 | "format" : "pve-node", | |
4225 | "type" : "string", | |
4226 | "typetext" : "<string>" | |
4227 | } | |
4228 | } | |
4229 | }, | |
4230 | "protected" : 1, | |
4231 | "proxyto" : "node", | |
4232 | "returns" : { | |
4233 | "items" : { | |
4234 | "properties" : {}, | |
4235 | "type" : "object" | |
4236 | }, | |
4237 | "links" : [ | |
4238 | { | |
4239 | "href" : "{service}", | |
4240 | "rel" : "child" | |
4241 | } | |
4242 | ], | |
4243 | "type" : "array" | |
4244 | } | |
4245 | } | |
4246 | }, | |
4247 | "leaf" : 0, | |
4248 | "path" : "/nodes/{node}/services", | |
4249 | "text" : "services" | |
4250 | }, | |
4251 | { | |
4252 | "info" : { | |
4253 | "GET" : { | |
4254 | "description" : "Read system log", | |
4255 | "method" : "GET", | |
4256 | "name" : "syslog", | |
4257 | "parameters" : { | |
4258 | "additionalProperties" : 0, | |
4259 | "properties" : { | |
4260 | "limit" : { | |
4261 | "minimum" : 0, | |
4262 | "optional" : 1, | |
4263 | "type" : "integer", | |
4264 | "typetext" : "<integer> (0 - N)" | |
4265 | }, | |
4266 | "node" : { | |
4267 | "description" : "The cluster node name.", | |
4268 | "format" : "pve-node", | |
4269 | "type" : "string", | |
4270 | "typetext" : "<string>" | |
4271 | }, | |
4272 | "since" : { | |
4273 | "description" : "Display all log since this date-time string.", | |
4274 | "optional" : 1, | |
4275 | "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$", | |
4276 | "type" : "string" | |
4277 | }, | |
4278 | "start" : { | |
4279 | "minimum" : 0, | |
4280 | "optional" : 1, | |
4281 | "type" : "integer", | |
4282 | "typetext" : "<integer> (0 - N)" | |
4283 | }, | |
4284 | "until" : { | |
4285 | "description" : "Display all log until this date-time string.", | |
4286 | "optional" : 1, | |
4287 | "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$", | |
4288 | "type" : "string" | |
4289 | } | |
4290 | } | |
4291 | }, | |
4292 | "protected" : 1, | |
4293 | "proxyto" : "node", | |
4294 | "returns" : { | |
4295 | "items" : { | |
4296 | "properties" : { | |
4297 | "n" : { | |
4298 | "description" : "Line number", | |
4299 | "type" : "integer" | |
4300 | }, | |
4301 | "t" : { | |
4302 | "description" : "Line text", | |
4303 | "type" : "string" | |
4304 | } | |
4305 | }, | |
4306 | "type" : "object" | |
4307 | }, | |
4308 | "type" : "array" | |
4309 | } | |
4310 | } | |
4311 | }, | |
4312 | "leaf" : 1, | |
4313 | "path" : "/nodes/{node}/syslog", | |
4314 | "text" : "syslog" | |
4315 | }, | |
4316 | { | |
4317 | "info" : { | |
4318 | "POST" : { | |
4319 | "description" : "Creates a VNC Shell proxy.", | |
4320 | "method" : "POST", | |
4321 | "name" : "vncshell", | |
4322 | "parameters" : { | |
4323 | "additionalProperties" : 0, | |
4324 | "properties" : { | |
4325 | "node" : { | |
4326 | "description" : "The cluster node name.", | |
4327 | "format" : "pve-node", | |
4328 | "type" : "string", | |
4329 | "typetext" : "<string>" | |
4330 | }, | |
4331 | "websocket" : { | |
4332 | "default" : 1, | |
4333 | "description" : "use websocket instead of standard vnc.", | |
4334 | "optional" : 1, | |
4335 | "type" : "boolean", | |
4336 | "typetext" : "<boolean>" | |
4337 | } | |
4338 | } | |
4339 | }, | |
4340 | "protected" : 1, | |
4341 | "returns" : { | |
4342 | "additionalProperties" : 0, | |
4343 | "properties" : { | |
4344 | "port" : { | |
4345 | "type" : "integer" | |
4346 | }, | |
4347 | "ticket" : { | |
4348 | "type" : "string" | |
4349 | }, | |
4350 | "upid" : { | |
4351 | "type" : "string" | |
4352 | }, | |
4353 | "user" : { | |
4354 | "type" : "string" | |
4355 | } | |
4356 | } | |
4357 | } | |
4358 | } | |
4359 | }, | |
4360 | "leaf" : 1, | |
4361 | "path" : "/nodes/{node}/vncshell", | |
4362 | "text" : "vncshell" | |
4363 | }, | |
4364 | { | |
4365 | "info" : { | |
4366 | "GET" : { | |
4367 | "description" : "Opens a weksocket for VNC traffic.", | |
4368 | "method" : "GET", | |
4369 | "name" : "vncwebsocket", | |
4370 | "parameters" : { | |
4371 | "additionalProperties" : 0, | |
4372 | "properties" : { | |
4373 | "node" : { | |
4374 | "description" : "The cluster node name.", | |
4375 | "format" : "pve-node", | |
4376 | "type" : "string", | |
4377 | "typetext" : "<string>" | |
4378 | }, | |
4379 | "port" : { | |
4380 | "description" : "Port number returned by previous vncproxy call.", | |
4381 | "maximum" : 5999, | |
4382 | "minimum" : 5900, | |
4383 | "type" : "integer", | |
4384 | "typetext" : "<integer> (5900 - 5999)" | |
4385 | }, | |
4386 | "vncticket" : { | |
4387 | "description" : "Ticket from previous call to vncproxy.", | |
4388 | "maxLength" : 512, | |
4389 | "type" : "string", | |
4390 | "typetext" : "<string>" | |
4391 | } | |
4392 | } | |
4393 | }, | |
4394 | "returns" : { | |
4395 | "properties" : { | |
4396 | "port" : { | |
4397 | "type" : "string" | |
4398 | } | |
4399 | }, | |
4400 | "type" : "object" | |
4401 | } | |
4402 | } | |
4403 | }, | |
4404 | "leaf" : 1, | |
4405 | "path" : "/nodes/{node}/vncwebsocket", | |
4406 | "text" : "vncwebsocket" | |
4407 | }, | |
4408 | { | |
4409 | "info" : { | |
4410 | "GET" : { | |
4411 | "description" : "Read DNS settings.", | |
4412 | "method" : "GET", | |
4413 | "name" : "dns", | |
4414 | "parameters" : { | |
4415 | "additionalProperties" : 0, | |
4416 | "properties" : { | |
4417 | "node" : { | |
4418 | "description" : "The cluster node name.", | |
4419 | "format" : "pve-node", | |
4420 | "type" : "string", | |
4421 | "typetext" : "<string>" | |
4422 | } | |
4423 | } | |
4424 | }, | |
4425 | "proxyto" : "node", | |
4426 | "returns" : { | |
4427 | "additionalProperties" : 0, | |
4428 | "properties" : { | |
4429 | "dns1" : { | |
4430 | "description" : "First name server IP address.", | |
4431 | "optional" : 1, | |
4432 | "type" : "string" | |
4433 | }, | |
4434 | "dns2" : { | |
4435 | "description" : "Second name server IP address.", | |
4436 | "optional" : 1, | |
4437 | "type" : "string" | |
4438 | }, | |
4439 | "dns3" : { | |
4440 | "description" : "Third name server IP address.", | |
4441 | "optional" : 1, | |
4442 | "type" : "string" | |
4443 | }, | |
4444 | "search" : { | |
4445 | "description" : "Search domain for host-name lookup.", | |
4446 | "optional" : 1, | |
4447 | "type" : "string" | |
4448 | } | |
4449 | }, | |
4450 | "type" : "object" | |
4451 | } | |
4452 | }, | |
4453 | "PUT" : { | |
4454 | "description" : "Write DNS settings.", | |
4455 | "method" : "PUT", | |
4456 | "name" : "update_dns", | |
4457 | "parameters" : { | |
4458 | "additionalProperties" : 0, | |
4459 | "properties" : { | |
4460 | "dns1" : { | |
4461 | "description" : "First name server IP address.", | |
4462 | "format" : "ip", | |
4463 | "optional" : 1, | |
4464 | "type" : "string", | |
4465 | "typetext" : "<string>" | |
4466 | }, | |
4467 | "dns2" : { | |
4468 | "description" : "Second name server IP address.", | |
4469 | "format" : "ip", | |
4470 | "optional" : 1, | |
4471 | "type" : "string", | |
4472 | "typetext" : "<string>" | |
4473 | }, | |
4474 | "dns3" : { | |
4475 | "description" : "Third name server IP address.", | |
4476 | "format" : "ip", | |
4477 | "optional" : 1, | |
4478 | "type" : "string", | |
4479 | "typetext" : "<string>" | |
4480 | }, | |
4481 | "node" : { | |
4482 | "description" : "The cluster node name.", | |
4483 | "format" : "pve-node", | |
4484 | "type" : "string", | |
4485 | "typetext" : "<string>" | |
4486 | }, | |
4487 | "search" : { | |
4488 | "description" : "Search domain for host-name lookup.", | |
4489 | "type" : "string", | |
4490 | "typetext" : "<string>" | |
4491 | } | |
4492 | } | |
4493 | }, | |
4494 | "protected" : 1, | |
4495 | "proxyto" : "node", | |
4496 | "returns" : { | |
4497 | "type" : "null" | |
4498 | } | |
4499 | } | |
4500 | }, | |
4501 | "leaf" : 1, | |
4502 | "path" : "/nodes/{node}/dns", | |
4503 | "text" : "dns" | |
4504 | }, | |
4505 | { | |
4506 | "info" : { | |
4507 | "GET" : { | |
4508 | "description" : "Read server time and time zone settings.", | |
4509 | "method" : "GET", | |
4510 | "name" : "time", | |
4511 | "parameters" : { | |
4512 | "additionalProperties" : 0, | |
4513 | "properties" : { | |
4514 | "node" : { | |
4515 | "description" : "The cluster node name.", | |
4516 | "format" : "pve-node", | |
4517 | "type" : "string", | |
4518 | "typetext" : "<string>" | |
4519 | } | |
4520 | } | |
4521 | }, | |
4522 | "proxyto" : "node", | |
4523 | "returns" : { | |
4524 | "additionalProperties" : 0, | |
4525 | "properties" : { | |
4526 | "localtime" : { | |
4527 | "description" : "Seconds since 1970-01-01 00:00:00 (local time)", | |
4528 | "minimum" : 1297163644, | |
4529 | "type" : "integer" | |
4530 | }, | |
4531 | "time" : { | |
4532 | "description" : "Seconds since 1970-01-01 00:00:00 UTC.", | |
4533 | "minimum" : 1297163644, | |
4534 | "type" : "integer" | |
4535 | }, | |
4536 | "timezone" : { | |
4537 | "description" : "Time zone", | |
4538 | "type" : "string" | |
4539 | } | |
4540 | }, | |
4541 | "type" : "object" | |
4542 | } | |
4543 | }, | |
4544 | "PUT" : { | |
4545 | "description" : "Set time zone.", | |
4546 | "method" : "PUT", | |
4547 | "name" : "set_timezone", | |
4548 | "parameters" : { | |
4549 | "additionalProperties" : 0, | |
4550 | "properties" : { | |
4551 | "node" : { | |
4552 | "description" : "The cluster node name.", | |
4553 | "format" : "pve-node", | |
4554 | "type" : "string", | |
4555 | "typetext" : "<string>" | |
4556 | }, | |
4557 | "timezone" : { | |
4558 | "description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.", | |
4559 | "type" : "string", | |
4560 | "typetext" : "<string>" | |
4561 | } | |
4562 | } | |
4563 | }, | |
4564 | "protected" : 1, | |
4565 | "proxyto" : "node", | |
4566 | "returns" : { | |
4567 | "type" : "null" | |
4568 | } | |
4569 | } | |
4570 | }, | |
4571 | "leaf" : 1, | |
4572 | "path" : "/nodes/{node}/time", | |
4573 | "text" : "time" | |
4574 | } | |
4575 | ], | |
4576 | "info" : { | |
4577 | "GET" : { | |
4578 | "description" : "Node index.", | |
4579 | "method" : "GET", | |
4580 | "name" : "index", | |
4581 | "parameters" : { | |
4582 | "additionalProperties" : 0, | |
4583 | "properties" : { | |
4584 | "node" : { | |
4585 | "description" : "The cluster node name.", | |
4586 | "format" : "pve-node", | |
4587 | "type" : "string", | |
4588 | "typetext" : "<string>" | |
4589 | } | |
4590 | } | |
4591 | }, | |
4592 | "permissions" : { | |
4593 | "user" : "all" | |
4594 | }, | |
4595 | "returns" : { | |
4596 | "items" : { | |
4597 | "properties" : {}, | |
4598 | "type" : "object" | |
4599 | }, | |
4600 | "links" : [ | |
4601 | { | |
4602 | "href" : "{name}", | |
4603 | "rel" : "child" | |
4604 | } | |
4605 | ], | |
4606 | "type" : "array" | |
4607 | } | |
4608 | } | |
4609 | }, | |
4610 | "leaf" : 0, | |
4611 | "path" : "/nodes/{node}", | |
4612 | "text" : "{node}" | |
4613 | } | |
4614 | ], | |
4615 | "info" : { | |
4616 | "GET" : { | |
4617 | "description" : "Cluster node index.", | |
4618 | "method" : "GET", | |
4619 | "name" : "index", | |
4620 | "parameters" : { | |
4621 | "additionalProperties" : 0 | |
4622 | }, | |
4623 | "permissions" : { | |
4624 | "user" : "all" | |
4625 | }, | |
4626 | "returns" : { | |
4627 | "items" : { | |
4628 | "properties" : {}, | |
4629 | "type" : "object" | |
4630 | }, | |
4631 | "links" : [ | |
4632 | { | |
4633 | "href" : "{node}", | |
4634 | "rel" : "child" | |
4635 | } | |
4636 | ], | |
4637 | "type" : "array" | |
4638 | } | |
4639 | } | |
4640 | }, | |
4641 | "leaf" : 0, | |
4642 | "path" : "/nodes", | |
4643 | "text" : "nodes" | |
4644 | }, | |
4645 | { | |
4646 | "children" : [ | |
4647 | { | |
4648 | "info" : { | |
4649 | "GET" : { | |
4650 | "description" : "Dummy. Useful for formaters which want to priovde a login page.", | |
4651 | "method" : "GET", | |
4652 | "name" : "get_ticket", | |
4653 | "parameters" : { | |
4654 | "additionalProperties" : 0 | |
4655 | }, | |
4656 | "permissions" : { | |
4657 | "user" : "world" | |
4658 | }, | |
4659 | "returns" : { | |
4660 | "type" : "null" | |
4661 | } | |
4662 | }, | |
4663 | "POST" : { | |
4664 | "description" : "Create or verify authentication ticket.", | |
4665 | "method" : "POST", | |
4666 | "name" : "create_ticket", | |
4667 | "parameters" : { | |
4668 | "additionalProperties" : 0, | |
4669 | "properties" : { | |
4670 | "otp" : { | |
4671 | "description" : "One-time password for Two-factor authentication.", | |
4672 | "optional" : 1, | |
4673 | "type" : "string", | |
4674 | "typetext" : "<string>" | |
4675 | }, | |
4676 | "password" : { | |
4677 | "description" : "The secret password. This can also be a valid ticket.", | |
4678 | "type" : "string", | |
4679 | "typetext" : "<string>" | |
4680 | }, | |
4681 | "realm" : { | |
4682 | "description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.", | |
4683 | "format" : "pmg-realm", | |
4684 | "maxLength" : 32, | |
4685 | "optional" : 1, | |
4686 | "type" : "string", | |
4687 | "typetext" : "<string>" | |
4688 | }, | |
4689 | "username" : { | |
4690 | "description" : "User name", | |
4691 | "maxLength" : 64, | |
4692 | "type" : "string", | |
4693 | "typetext" : "<string>" | |
4694 | } | |
4695 | } | |
4696 | }, | |
4697 | "permissions" : { | |
4698 | "description" : "You need to pass valid credientials.", | |
4699 | "user" : "world" | |
4700 | }, | |
4701 | "protected" : 1, | |
4702 | "returns" : { | |
4703 | "properties" : { | |
4704 | "CSRFPreventionToken" : { | |
4705 | "optional" : 1, | |
4706 | "type" : "string" | |
4707 | }, | |
4708 | "ticket" : { | |
4709 | "optional" : 1, | |
4710 | "type" : "string" | |
4711 | }, | |
4712 | "username" : { | |
4713 | "type" : "string" | |
4714 | } | |
4715 | }, | |
4716 | "type" : "object" | |
4717 | } | |
4718 | } | |
4719 | }, | |
4720 | "leaf" : 1, | |
4721 | "path" : "/access/ticket", | |
4722 | "text" : "ticket" | |
4723 | }, | |
4724 | { | |
4725 | "info" : { | |
4726 | "PUT" : { | |
4727 | "description" : "Change user password.", | |
4728 | "method" : "PUT", | |
4729 | "name" : "change_passsword", | |
4730 | "parameters" : { | |
4731 | "additionalProperties" : 0, | |
4732 | "properties" : { | |
4733 | "password" : { | |
4734 | "description" : "The new password.", | |
4735 | "maxLength" : 64, | |
4736 | "minLength" : 5, | |
4737 | "type" : "string", | |
4738 | "typetext" : "<string>" | |
4739 | }, | |
4740 | "userid" : { | |
4741 | "description" : "User ID", | |
4742 | "format" : "pmg-userid", | |
4743 | "maxLength" : 64, | |
4744 | "type" : "string", | |
4745 | "typetext" : "<string>" | |
4746 | } | |
4747 | } | |
4748 | }, | |
4749 | "protected" : 1, | |
4750 | "returns" : { | |
4751 | "type" : "null" | |
4752 | } | |
4753 | } | |
4754 | }, | |
4755 | "leaf" : 1, | |
4756 | "path" : "/access/password", | |
4757 | "text" : "password" | |
4758 | } | |
4759 | ], | |
4760 | "info" : { | |
4761 | "GET" : { | |
4762 | "description" : "Directory index.", | |
4763 | "method" : "GET", | |
4764 | "name" : "index", | |
4765 | "parameters" : { | |
4766 | "additionalProperties" : 0 | |
4767 | }, | |
4768 | "permissions" : { | |
4769 | "user" : "all" | |
4770 | }, | |
4771 | "returns" : { | |
4772 | "items" : { | |
4773 | "properties" : { | |
4774 | "subdir" : { | |
4775 | "type" : "string" | |
4776 | } | |
4777 | }, | |
4778 | "type" : "object" | |
4779 | }, | |
4780 | "links" : [ | |
4781 | { | |
4782 | "href" : "{subdir}", | |
4783 | "rel" : "child" | |
4784 | } | |
4785 | ], | |
4786 | "type" : "array" | |
4787 | } | |
4788 | } | |
4789 | }, | |
4790 | "leaf" : 0, | |
4791 | "path" : "/access", | |
4792 | "text" : "access" | |
4793 | }, | |
4794 | { | |
4795 | "info" : { | |
4796 | "GET" : { | |
4797 | "description" : "API version details.", | |
4798 | "method" : "GET", | |
4799 | "name" : "version", | |
4800 | "parameters" : { | |
4801 | "additionalProperties" : 0 | |
4802 | }, | |
4803 | "permissions" : { | |
4804 | "user" : "all" | |
4805 | }, | |
4806 | "returns" : { | |
4807 | "properties" : { | |
4808 | "release" : { | |
4809 | "type" : "string" | |
4810 | }, | |
4811 | "repoid" : { | |
4812 | "type" : "string" | |
4813 | }, | |
4814 | "version" : { | |
4815 | "type" : "string" | |
4816 | } | |
4817 | }, | |
4818 | "type" : "object" | |
4819 | } | |
4820 | } | |
4821 | }, | |
4822 | "leaf" : 1, | |
4823 | "path" : "/version", | |
4824 | "text" : "version" | |
4825 | } | |
4826 | ] | |
4827 | ; | |
4828 |