]> git.proxmox.com Git - pmg-docs.git/blob - api-viewer/apidata.js
projects / pmg-docs.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
update generated docs
[pmg-docs.git] / api-viewer / apidata.js
1 var pmgapi = [
2 {
3 "children" : [
4 {
5 "children" : [
6 {
7 "children" : [
8 {
9 "children" : [
10 {
11 "info" : {
12 "GET" : {
13 "description" : "Get common rule properties.",
14 "method" : "GET",
15 "name" : "config",
16 "parameters" : {
17 "additionalProperties" : 0,
18 "properties" : {
19 "id" : {
20 "description" : "Rule ID.",
21 "type" : "integer",
22 "typetext" : "<integer>"
23 }
24 }
25 },
26 "proxyto" : "master",
27 "returns" : {
28 "properties" : {
29 "active" : {
30 "type" : "boolean"
31 },
32 "direction" : {
33 "type" : "integer"
34 },
35 "id" : {
36 "type" : "integer"
37 },
38 "name" : {
39 "type" : "string"
40 },
41 "priority" : {
42 "type" : "integer"
43 }
44 },
45 "type" : "object"
46 }
47 },
48 "PUT" : {
49 "description" : "Set rule properties.",
50 "method" : "PUT",
51 "name" : "update_config",
52 "parameters" : {
53 "additionalProperties" : 0,
54 "properties" : {
55 "active" : {
56 "description" : "Flag to activate rule.",
57 "optional" : 1,
58 "type" : "boolean",
59 "typetext" : "<boolean>"
60 },
61 "direction" : {
62 "description" : "Rule direction. Value `0` matches incomming mails, value `1` matches outgoing mails, and value `2` matches both directions.",
63 "maximum" : 2,
64 "minimum" : 0,
65 "optional" : 1,
66 "type" : "integer",
67 "typetext" : "<integer> (0 - 2)"
68 },
69 "id" : {
70 "description" : "Rule ID.",
71 "type" : "integer",
72 "typetext" : "<integer>"
73 },
74 "name" : {
75 "description" : "Rule name",
76 "optional" : 1,
77 "type" : "string",
78 "typetext" : "<string>"
79 },
80 "priority" : {
81 "description" : "Rule priotity.",
82 "maximum" : 100,
83 "minimum" : 0,
84 "optional" : 1,
85 "type" : "integer",
86 "typetext" : "<integer> (0 - 100)"
87 }
88 }
89 },
90 "protected" : 1,
91 "proxyto" : "master",
92 "returns" : {
93 "type" : "null"
94 }
95 }
96 },
97 "leaf" : 1,
98 "path" : "/config/ruledb/rules/{id}/config",
99 "text" : "config"
100 },
101 {
102 "children" : [
103 {
104 "info" : {
105 "DELETE" : {
106 "description" : "Delete group from 'from' list.",
107 "method" : "DELETE",
108 "name" : "delete_from_group",
109 "parameters" : {
110 "additionalProperties" : 0,
111 "properties" : {
112 "id" : {
113 "description" : "Rule ID.",
114 "type" : "integer",
115 "typetext" : "<integer>"
116 },
117 "ogroup" : {
118 "description" : "Groups ID.",
119 "type" : "integer",
120 "typetext" : "<integer>"
121 }
122 }
123 },
124 "protected" : 1,
125 "proxyto" : "master",
126 "returns" : {
127 "type" : "null"
128 }
129 }
130 },
131 "leaf" : 1,
132 "path" : "/config/ruledb/rules/{id}/from/{ogroup}",
133 "text" : "{ogroup}"
134 }
135 ],
136 "info" : {
137 "GET" : {
138 "description" : "Get 'from' group list.",
139 "method" : "GET",
140 "name" : "from",
141 "parameters" : {
142 "additionalProperties" : 0,
143 "properties" : {
144 "id" : {
145 "description" : "Rule ID.",
146 "type" : "integer",
147 "typetext" : "<integer>"
148 }
149 }
150 },
151 "proxyto" : "master",
152 "returns" : {
153 "items" : {
154 "properties" : {
155 "id" : {
156 "type" : "integer"
157 }
158 },
159 "type" : "object"
160 },
161 "type" : "array"
162 }
163 },
164 "POST" : {
165 "description" : "Add group to 'from' list.",
166 "method" : "POST",
167 "name" : "add_from_group",
168 "parameters" : {
169 "additionalProperties" : 0,
170 "properties" : {
171 "id" : {
172 "description" : "Rule ID.",
173 "type" : "integer",
174 "typetext" : "<integer>"
175 },
176 "ogroup" : {
177 "description" : "Groups ID.",
178 "type" : "integer",
179 "typetext" : "<integer>"
180 }
181 }
182 },
183 "protected" : 1,
184 "proxyto" : "master",
185 "returns" : {
186 "type" : "null"
187 }
188 }
189 },
190 "leaf" : 0,
191 "path" : "/config/ruledb/rules/{id}/from",
192 "text" : "from"
193 },
194 {
195 "children" : [
196 {
197 "info" : {
198 "DELETE" : {
199 "description" : "Delete group from 'to' list.",
200 "method" : "DELETE",
201 "name" : "delete_to_group",
202 "parameters" : {
203 "additionalProperties" : 0,
204 "properties" : {
205 "id" : {
206 "description" : "Rule ID.",
207 "type" : "integer",
208 "typetext" : "<integer>"
209 },
210 "ogroup" : {
211 "description" : "Groups ID.",
212 "type" : "integer",
213 "typetext" : "<integer>"
214 }
215 }
216 },
217 "protected" : 1,
218 "proxyto" : "master",
219 "returns" : {
220 "type" : "null"
221 }
222 }
223 },
224 "leaf" : 1,
225 "path" : "/config/ruledb/rules/{id}/to/{ogroup}",
226 "text" : "{ogroup}"
227 }
228 ],
229 "info" : {
230 "GET" : {
231 "description" : "Get 'to' group list.",
232 "method" : "GET",
233 "name" : "to",
234 "parameters" : {
235 "additionalProperties" : 0,
236 "properties" : {
237 "id" : {
238 "description" : "Rule ID.",
239 "type" : "integer",
240 "typetext" : "<integer>"
241 }
242 }
243 },
244 "proxyto" : "master",
245 "returns" : {
246 "items" : {
247 "properties" : {
248 "id" : {
249 "type" : "integer"
250 }
251 },
252 "type" : "object"
253 },
254 "type" : "array"
255 }
256 },
257 "POST" : {
258 "description" : "Add group to 'to' list.",
259 "method" : "POST",
260 "name" : "add_to_group",
261 "parameters" : {
262 "additionalProperties" : 0,
263 "properties" : {
264 "id" : {
265 "description" : "Rule ID.",
266 "type" : "integer",
267 "typetext" : "<integer>"
268 },
269 "ogroup" : {
270 "description" : "Groups ID.",
271 "type" : "integer",
272 "typetext" : "<integer>"
273 }
274 }
275 },
276 "protected" : 1,
277 "proxyto" : "master",
278 "returns" : {
279 "type" : "null"
280 }
281 }
282 },
283 "leaf" : 0,
284 "path" : "/config/ruledb/rules/{id}/to",
285 "text" : "to"
286 },
287 {
288 "children" : [
289 {
290 "info" : {
291 "DELETE" : {
292 "description" : "Delete group from 'when' list.",
293 "method" : "DELETE",
294 "name" : "delete_when_group",
295 "parameters" : {
296 "additionalProperties" : 0,
297 "properties" : {
298 "id" : {
299 "description" : "Rule ID.",
300 "type" : "integer",
301 "typetext" : "<integer>"
302 },
303 "ogroup" : {
304 "description" : "Groups ID.",
305 "type" : "integer",
306 "typetext" : "<integer>"
307 }
308 }
309 },
310 "protected" : 1,
311 "proxyto" : "master",
312 "returns" : {
313 "type" : "null"
314 }
315 }
316 },
317 "leaf" : 1,
318 "path" : "/config/ruledb/rules/{id}/when/{ogroup}",
319 "text" : "{ogroup}"
320 }
321 ],
322 "info" : {
323 "GET" : {
324 "description" : "Get 'when' group list.",
325 "method" : "GET",
326 "name" : "when",
327 "parameters" : {
328 "additionalProperties" : 0,
329 "properties" : {
330 "id" : {
331 "description" : "Rule ID.",
332 "type" : "integer",
333 "typetext" : "<integer>"
334 }
335 }
336 },
337 "proxyto" : "master",
338 "returns" : {
339 "items" : {
340 "properties" : {
341 "id" : {
342 "type" : "integer"
343 }
344 },
345 "type" : "object"
346 },
347 "type" : "array"
348 }
349 },
350 "POST" : {
351 "description" : "Add group to 'when' list.",
352 "method" : "POST",
353 "name" : "add_when_group",
354 "parameters" : {
355 "additionalProperties" : 0,
356 "properties" : {
357 "id" : {
358 "description" : "Rule ID.",
359 "type" : "integer",
360 "typetext" : "<integer>"
361 },
362 "ogroup" : {
363 "description" : "Groups ID.",
364 "type" : "integer",
365 "typetext" : "<integer>"
366 }
367 }
368 },
369 "protected" : 1,
370 "proxyto" : "master",
371 "returns" : {
372 "type" : "null"
373 }
374 }
375 },
376 "leaf" : 0,
377 "path" : "/config/ruledb/rules/{id}/when",
378 "text" : "when"
379 },
380 {
381 "children" : [
382 {
383 "info" : {
384 "DELETE" : {
385 "description" : "Delete group from 'what' list.",
386 "method" : "DELETE",
387 "name" : "delete_what_group",
388 "parameters" : {
389 "additionalProperties" : 0,
390 "properties" : {
391 "id" : {
392 "description" : "Rule ID.",
393 "type" : "integer",
394 "typetext" : "<integer>"
395 },
396 "ogroup" : {
397 "description" : "Groups ID.",
398 "type" : "integer",
399 "typetext" : "<integer>"
400 }
401 }
402 },
403 "protected" : 1,
404 "proxyto" : "master",
405 "returns" : {
406 "type" : "null"
407 }
408 }
409 },
410 "leaf" : 1,
411 "path" : "/config/ruledb/rules/{id}/what/{ogroup}",
412 "text" : "{ogroup}"
413 }
414 ],
415 "info" : {
416 "GET" : {
417 "description" : "Get 'what' group list.",
418 "method" : "GET",
419 "name" : "what",
420 "parameters" : {
421 "additionalProperties" : 0,
422 "properties" : {
423 "id" : {
424 "description" : "Rule ID.",
425 "type" : "integer",
426 "typetext" : "<integer>"
427 }
428 }
429 },
430 "proxyto" : "master",
431 "returns" : {
432 "items" : {
433 "properties" : {
434 "id" : {
435 "type" : "integer"
436 }
437 },
438 "type" : "object"
439 },
440 "type" : "array"
441 }
442 },
443 "POST" : {
444 "description" : "Add group to 'what' list.",
445 "method" : "POST",
446 "name" : "add_what_group",
447 "parameters" : {
448 "additionalProperties" : 0,
449 "properties" : {
450 "id" : {
451 "description" : "Rule ID.",
452 "type" : "integer",
453 "typetext" : "<integer>"
454 },
455 "ogroup" : {
456 "description" : "Groups ID.",
457 "type" : "integer",
458 "typetext" : "<integer>"
459 }
460 }
461 },
462 "protected" : 1,
463 "proxyto" : "master",
464 "returns" : {
465 "type" : "null"
466 }
467 }
468 },
469 "leaf" : 0,
470 "path" : "/config/ruledb/rules/{id}/what",
471 "text" : "what"
472 },
473 {
474 "children" : [
475 {
476 "info" : {
477 "DELETE" : {
478 "description" : "Delete group from 'action' list.",
479 "method" : "DELETE",
480 "name" : "delete_action_group",
481 "parameters" : {
482 "additionalProperties" : 0,
483 "properties" : {
484 "id" : {
485 "description" : "Rule ID.",
486 "type" : "integer",
487 "typetext" : "<integer>"
488 },
489 "ogroup" : {
490 "description" : "Groups ID.",
491 "type" : "integer",
492 "typetext" : "<integer>"
493 }
494 }
495 },
496 "protected" : 1,
497 "proxyto" : "master",
498 "returns" : {
499 "type" : "null"
500 }
501 }
502 },
503 "leaf" : 1,
504 "path" : "/config/ruledb/rules/{id}/action/{ogroup}",
505 "text" : "{ogroup}"
506 }
507 ],
508 "info" : {
509 "GET" : {
510 "description" : "Get 'action' group list.",
511 "method" : "GET",
512 "name" : "action",
513 "parameters" : {
514 "additionalProperties" : 0,
515 "properties" : {
516 "id" : {
517 "description" : "Rule ID.",
518 "type" : "integer",
519 "typetext" : "<integer>"
520 }
521 }
522 },
523 "proxyto" : "master",
524 "returns" : {
525 "items" : {
526 "properties" : {
527 "id" : {
528 "type" : "integer"
529 }
530 },
531 "type" : "object"
532 },
533 "type" : "array"
534 }
535 },
536 "POST" : {
537 "description" : "Add group to 'action' list.",
538 "method" : "POST",
539 "name" : "add_action_group",
540 "parameters" : {
541 "additionalProperties" : 0,
542 "properties" : {
543 "id" : {
544 "description" : "Rule ID.",
545 "type" : "integer",
546 "typetext" : "<integer>"
547 },
548 "ogroup" : {
549 "description" : "Groups ID.",
550 "type" : "integer",
551 "typetext" : "<integer>"
552 }
553 }
554 },
555 "protected" : 1,
556 "proxyto" : "master",
557 "returns" : {
558 "type" : "null"
559 }
560 }
561 },
562 "leaf" : 0,
563 "path" : "/config/ruledb/rules/{id}/action",
564 "text" : "action"
565 }
566 ],
567 "info" : {
568 "DELETE" : {
569 "description" : "Delete rule.",
570 "method" : "DELETE",
571 "name" : "delete_rule",
572 "parameters" : {
573 "additionalProperties" : 0,
574 "properties" : {
575 "id" : {
576 "description" : "Rule ID.",
577 "type" : "integer",
578 "typetext" : "<integer>"
579 }
580 }
581 },
582 "returns" : {
583 "type" : "null"
584 }
585 },
586 "GET" : {
587 "description" : "Directory index.",
588 "method" : "GET",
589 "name" : "index",
590 "parameters" : {
591 "additionalProperties" : 0,
592 "properties" : {
593 "id" : {
594 "description" : "Rule ID.",
595 "type" : "integer",
596 "typetext" : "<integer>"
597 }
598 }
599 },
600 "returns" : {
601 "items" : {
602 "properties" : {
603 "subdir" : {
604 "type" : "string"
605 }
606 },
607 "type" : "object"
608 },
609 "links" : [
610 {
611 "href" : "{subdir}",
612 "rel" : "child"
613 }
614 ],
615 "type" : "array"
616 }
617 }
618 },
619 "leaf" : 0,
620 "path" : "/config/ruledb/rules/{id}",
621 "text" : "{id}"
622 }
623 ],
624 "info" : {
625 "GET" : {
626 "description" : "Get list of rules.",
627 "method" : "GET",
628 "name" : "list_rules",
629 "parameters" : {
630 "additionalProperties" : 0
631 },
632 "protected" : 1,
633 "proxyto" : "master",
634 "returns" : {
635 "items" : {
636 "properties" : {
637 "id" : {
638 "type" : "integer"
639 }
640 },
641 "type" : "object"
642 },
643 "links" : [
644 {
645 "href" : "{id}",
646 "rel" : "child"
647 }
648 ],
649 "type" : "array"
650 }
651 },
652 "POST" : {
653 "description" : "Create new rule.",
654 "method" : "POST",
655 "name" : "create_rule",
656 "parameters" : {
657 "additionalProperties" : 0,
658 "properties" : {
659 "active" : {
660 "description" : "Flag to activate rule.",
661 "optional" : 1,
662 "type" : "boolean",
663 "typetext" : "<boolean>"
664 },
665 "direction" : {
666 "description" : "Rule direction. Value `0` matches incomming mails, value `1` matches outgoing mails, and value `2` matches both directions.",
667 "maximum" : 2,
668 "minimum" : 0,
669 "optional" : 1,
670 "type" : "integer",
671 "typetext" : "<integer> (0 - 2)"
672 },
673 "name" : {
674 "description" : "Rule name",
675 "type" : "string",
676 "typetext" : "<string>"
677 },
678 "priority" : {
679 "description" : "Rule priotity.",
680 "maximum" : 100,
681 "minimum" : 0,
682 "type" : "integer",
683 "typetext" : "<integer> (0 - 100)"
684 }
685 }
686 },
687 "protected" : 1,
688 "proxyto" : "master",
689 "returns" : {
690 "type" : "integer"
691 }
692 }
693 },
694 "leaf" : 0,
695 "path" : "/config/ruledb/rules",
696 "text" : "rules"
697 },
698 {
699 "children" : [
700 {
701 "children" : [
702 {
703 "info" : {
704 "DELETE" : {
705 "description" : "Delete 'actions' object.",
706 "method" : "DELETE",
707 "name" : "delete_action",
708 "parameters" : {
709 "additionalProperties" : 0,
710 "properties" : {
711 "id" : {
712 "description" : "Action Object ID.",
713 "pattern" : "\\d+_\\d+",
714 "type" : "string"
715 }
716 }
717 },
718 "returns" : {
719 "type" : "null"
720 }
721 }
722 },
723 "leaf" : 1,
724 "path" : "/config/ruledb/action/objects/{id}",
725 "text" : "{id}"
726 }
727 ],
728 "info" : {
729 "GET" : {
730 "description" : "List 'actions' objects.",
731 "method" : "GET",
732 "name" : "list_actions",
733 "parameters" : {
734 "additionalProperties" : 0
735 },
736 "returns" : {
737 "items" : {
738 "properties" : {
739 "id" : {
740 "description" : "Action Object ID.",
741 "pattern" : "\\d+_\\d+",
742 "type" : "string"
743 }
744 },
745 "type" : "object"
746 },
747 "links" : [
748 {
749 "href" : "{id}",
750 "rel" : "child"
751 }
752 ],
753 "type" : "array"
754 }
755 }
756 },
757 "leaf" : 0,
758 "path" : "/config/ruledb/action/objects",
759 "text" : "objects"
760 },
761 {
762 "children" : [
763 {
764 "info" : {
765 "GET" : {
766 "description" : "Read 'BCC' object settings.",
767 "method" : "GET",
768 "name" : "read_bcc",
769 "parameters" : {
770 "additionalProperties" : 0,
771 "properties" : {
772 "id" : {
773 "description" : "Action Object ID.",
774 "pattern" : "\\d+_\\d+",
775 "type" : "string"
776 }
777 }
778 },
779 "proxyto" : "master",
780 "returns" : {
781 "properties" : {
782 "id" : {
783 "type" : "string"
784 }
785 },
786 "type" : "object"
787 }
788 },
789 "PUT" : {
790 "description" : "Update 'BCC' object.",
791 "method" : "PUT",
792 "name" : "update_bcc",
793 "parameters" : {
794 "additionalProperties" : 0,
795 "properties" : {
796 "id" : {
797 "description" : "Action Object ID.",
798 "pattern" : "\\d+_\\d+",
799 "type" : "string"
800 },
801 "info" : {
802 "description" : "Informational comment.",
803 "maxLength" : 255,
804 "optional" : 1,
805 "type" : "string",
806 "typetext" : "<string>"
807 },
808 "name" : {
809 "description" : "Action name.",
810 "maxLength" : 255,
811 "optional" : 1,
812 "type" : "string",
813 "typetext" : "<string>"
814 },
815 "original" : {
816 "default" : 1,
817 "description" : "Send the original, unmodified mail.",
818 "optional" : 1,
819 "type" : "boolean",
820 "typetext" : "<boolean>"
821 },
822 "target" : {
823 "description" : "Send a Blind Carbon Copy to this email address.",
824 "format" : "email",
825 "type" : "string",
826 "typetext" : "<string>"
827 }
828 }
829 },
830 "proxyto" : "master",
831 "returns" : {
832 "type" : "null"
833 }
834 }
835 },
836 "leaf" : 1,
837 "path" : "/config/ruledb/action/bcc/{id}",
838 "text" : "{id}"
839 }
840 ],
841 "info" : {
842 "POST" : {
843 "description" : "Create 'BCC' object.",
844 "method" : "POST",
845 "name" : "bcc",
846 "parameters" : {
847 "additionalProperties" : 0,
848 "properties" : {
849 "info" : {
850 "description" : "Informational comment.",
851 "maxLength" : 255,
852 "optional" : 1,
853 "type" : "string",
854 "typetext" : "<string>"
855 },
856 "name" : {
857 "description" : "Action name.",
858 "maxLength" : 255,
859 "type" : "string",
860 "typetext" : "<string>"
861 },
862 "original" : {
863 "default" : 1,
864 "description" : "Send the original, unmodified mail.",
865 "optional" : 1,
866 "type" : "boolean",
867 "typetext" : "<boolean>"
868 },
869 "target" : {
870 "description" : "Send a Blind Carbon Copy to this email address.",
871 "format" : "email",
872 "type" : "string",
873 "typetext" : "<string>"
874 }
875 }
876 },
877 "proxyto" : "master",
878 "returns" : {
879 "description" : "The object ID.",
880 "type" : "string"
881 }
882 }
883 },
884 "leaf" : 0,
885 "path" : "/config/ruledb/action/bcc",
886 "text" : "bcc"
887 }
888 ],
889 "info" : {
890 "GET" : {
891 "description" : "Directory index.",
892 "method" : "GET",
893 "name" : "index",
894 "parameters" : {
895 "additionalProperties" : 0
896 },
897 "returns" : {
898 "items" : {
899 "properties" : {
900 "subdir" : {
901 "type" : "string"
902 }
903 },
904 "type" : "object"
905 },
906 "links" : [
907 {
908 "href" : "{subdir}",
909 "rel" : "child"
910 }
911 ],
912 "type" : "array"
913 }
914 }
915 },
916 "leaf" : 0,
917 "path" : "/config/ruledb/action",
918 "text" : "action"
919 },
920 {
921 "children" : [
922 {
923 "children" : [
924 {
925 "info" : {
926 "GET" : {
927 "description" : "Get 'what' group properties",
928 "method" : "GET",
929 "name" : "get_config",
930 "parameters" : {
931 "additionalProperties" : 0,
932 "properties" : {
933 "ogroup" : {
934 "description" : "Object Group ID.",
935 "type" : "integer",
936 "typetext" : "<integer>"
937 }
938 }
939 },
940 "proxyto" : "master",
941 "returns" : {
942 "properties" : {
943 "id" : {
944 "type" : "integer"
945 },
946 "info" : {
947 "type" : "string"
948 },
949 "name" : {
950 "type" : "string"
951 }
952 },
953 "type" : "object"
954 }
955 },
956 "PUT" : {
957 "description" : "Modify 'what' group properties",
958 "method" : "PUT",
959 "name" : "set_config",
960 "parameters" : {
961 "additionalProperties" : 0,
962 "properties" : {
963 "info" : {
964 "description" : "Informational comment.",
965 "maxLength" : 255,
966 "optional" : 1,
967 "type" : "string",
968 "typetext" : "<string>"
969 },
970 "name" : {
971 "description" : "Group name.",
972 "maxLength" : 255,
973 "optional" : 1,
974 "type" : "string",
975 "typetext" : "<string>"
976 },
977 "ogroup" : {
978 "description" : "Object Group ID.",
979 "type" : "integer",
980 "typetext" : "<integer>"
981 }
982 }
983 },
984 "proxyto" : "master",
985 "returns" : {
986 "type" : "null"
987 }
988 }
989 },
990 "leaf" : 1,
991 "path" : "/config/ruledb/what/{ogroup}/config",
992 "text" : "config"
993 },
994 {
995 "children" : [
996 {
997 "info" : {
998 "DELETE" : {
999 "description" : "Remove an object from the 'what' group.",
1000 "method" : "DELETE",
1001 "name" : "delete_object",
1002 "parameters" : {
1003 "additionalProperties" : 0,
1004 "properties" : {
1005 "id" : {
1006 "description" : "Object ID.",
1007 "type" : "integer",
1008 "typetext" : "<integer>"
1009 },
1010 "ogroup" : {
1011 "description" : "Object Group ID.",
1012 "type" : "integer",
1013 "typetext" : "<integer>"
1014 }
1015 }
1016 },
1017 "protected" : 1,
1018 "proxyto" : "master",
1019 "returns" : {
1020 "type" : "null"
1021 }
1022 }
1023 },
1024 "leaf" : 1,
1025 "path" : "/config/ruledb/what/{ogroup}/objects/{id}",
1026 "text" : "{id}"
1027 }
1028 ],
1029 "info" : {
1030 "GET" : {
1031 "description" : "List 'what' group objects.",
1032 "method" : "GET",
1033 "name" : "objects",
1034 "parameters" : {
1035 "additionalProperties" : 0,
1036 "properties" : {
1037 "ogroup" : {
1038 "description" : "Object Group ID.",
1039 "type" : "integer",
1040 "typetext" : "<integer>"
1041 }
1042 }
1043 },
1044 "proxyto" : "master",
1045 "returns" : {
1046 "items" : {
1047 "properties" : {
1048 "id" : {
1049 "type" : "integer"
1050 }
1051 },
1052 "type" : "object"
1053 },
1054 "links" : [
1055 {
1056 "href" : "{id}",
1057 "rel" : "child"
1058 }
1059 ],
1060 "type" : "array"
1061 }
1062 }
1063 },
1064 "leaf" : 0,
1065 "path" : "/config/ruledb/what/{ogroup}/objects",
1066 "text" : "objects"
1067 }
1068 ],
1069 "info" : {
1070 "DELETE" : {
1071 "description" : "Delete a 'what' group.",
1072 "method" : "DELETE",
1073 "name" : "delete_{$oclass}_group",
1074 "parameters" : {
1075 "additionalProperties" : 0,
1076 "properties" : {
1077 "ogroup" : {
1078 "description" : "Object Group ID.",
1079 "type" : "integer",
1080 "typetext" : "<integer>"
1081 }
1082 }
1083 },
1084 "protected" : 1,
1085 "proxyto" : "master",
1086 "returns" : {
1087 "type" : "null"
1088 }
1089 },
1090 "GET" : {
1091 "description" : "Directory index.",
1092 "method" : "GET",
1093 "name" : "index",
1094 "parameters" : {
1095 "additionalProperties" : 0,
1096 "properties" : {
1097 "ogroup" : {
1098 "description" : "Object Group ID.",
1099 "type" : "integer",
1100 "typetext" : "<integer>"
1101 }
1102 }
1103 },
1104 "returns" : {
1105 "items" : {
1106 "properties" : {
1107 "subdir" : {
1108 "type" : "string"
1109 }
1110 },
1111 "type" : "object"
1112 },
1113 "links" : [
1114 {
1115 "href" : "{subdir}",
1116 "rel" : "child"
1117 }
1118 ],
1119 "type" : "array"
1120 }
1121 }
1122 },
1123 "leaf" : 0,
1124 "path" : "/config/ruledb/what/{ogroup}",
1125 "text" : "{ogroup}"
1126 }
1127 ],
1128 "info" : {
1129 "GET" : {
1130 "description" : "Get list of 'what' groups.",
1131 "method" : "GET",
1132 "name" : "list_what_groups",
1133 "parameters" : {
1134 "additionalProperties" : 0
1135 },
1136 "protected" : 1,
1137 "proxyto" : "master",
1138 "returns" : {
1139 "items" : {
1140 "properties" : {
1141 "id" : {
1142 "type" : "integer"
1143 }
1144 },
1145 "type" : "object"
1146 },
1147 "type" : "array"
1148 }
1149 },
1150 "POST" : {
1151 "description" : "Create a new 'what' group.",
1152 "method" : "POST",
1153 "name" : "create_what_group",
1154 "parameters" : {
1155 "additionalProperties" : 0,
1156 "properties" : {
1157 "info" : {
1158 "description" : "Informational comment.",
1159 "maxLength" : 255,
1160 "optional" : 1,
1161 "type" : "string",
1162 "typetext" : "<string>"
1163 },
1164 "name" : {
1165 "description" : "Group name.",
1166 "maxLength" : 255,
1167 "type" : "string",
1168 "typetext" : "<string>"
1169 }
1170 }
1171 },
1172 "protected" : 1,
1173 "proxyto" : "master",
1174 "returns" : {
1175 "type" : "integer"
1176 }
1177 }
1178 },
1179 "leaf" : 0,
1180 "path" : "/config/ruledb/what",
1181 "text" : "what"
1182 },
1183 {
1184 "children" : [
1185 {
1186 "children" : [
1187 {
1188 "info" : {
1189 "GET" : {
1190 "description" : "Get 'when' group properties",
1191 "method" : "GET",
1192 "name" : "get_config",
1193 "parameters" : {
1194 "additionalProperties" : 0,
1195 "properties" : {
1196 "ogroup" : {
1197 "description" : "Object Group ID.",
1198 "type" : "integer",
1199 "typetext" : "<integer>"
1200 }
1201 }
1202 },
1203 "proxyto" : "master",
1204 "returns" : {
1205 "properties" : {
1206 "id" : {
1207 "type" : "integer"
1208 },
1209 "info" : {
1210 "type" : "string"
1211 },
1212 "name" : {
1213 "type" : "string"
1214 }
1215 },
1216 "type" : "object"
1217 }
1218 },
1219 "PUT" : {
1220 "description" : "Modify 'when' group properties",
1221 "method" : "PUT",
1222 "name" : "set_config",
1223 "parameters" : {
1224 "additionalProperties" : 0,
1225 "properties" : {
1226 "info" : {
1227 "description" : "Informational comment.",
1228 "maxLength" : 255,
1229 "optional" : 1,
1230 "type" : "string",
1231 "typetext" : "<string>"
1232 },
1233 "name" : {
1234 "description" : "Group name.",
1235 "maxLength" : 255,
1236 "optional" : 1,
1237 "type" : "string",
1238 "typetext" : "<string>"
1239 },
1240 "ogroup" : {
1241 "description" : "Object Group ID.",
1242 "type" : "integer",
1243 "typetext" : "<integer>"
1244 }
1245 }
1246 },
1247 "proxyto" : "master",
1248 "returns" : {
1249 "type" : "null"
1250 }
1251 }
1252 },
1253 "leaf" : 1,
1254 "path" : "/config/ruledb/when/{ogroup}/config",
1255 "text" : "config"
1256 },
1257 {
1258 "children" : [
1259 {
1260 "info" : {
1261 "DELETE" : {
1262 "description" : "Remove an object from the 'when' group.",
1263 "method" : "DELETE",
1264 "name" : "delete_object",
1265 "parameters" : {
1266 "additionalProperties" : 0,
1267 "properties" : {
1268 "id" : {
1269 "description" : "Object ID.",
1270 "type" : "integer",
1271 "typetext" : "<integer>"
1272 },
1273 "ogroup" : {
1274 "description" : "Object Group ID.",
1275 "type" : "integer",
1276 "typetext" : "<integer>"
1277 }
1278 }
1279 },
1280 "protected" : 1,
1281 "proxyto" : "master",
1282 "returns" : {
1283 "type" : "null"
1284 }
1285 }
1286 },
1287 "leaf" : 1,
1288 "path" : "/config/ruledb/when/{ogroup}/objects/{id}",
1289 "text" : "{id}"
1290 }
1291 ],
1292 "info" : {
1293 "GET" : {
1294 "description" : "List 'when' group objects.",
1295 "method" : "GET",
1296 "name" : "objects",
1297 "parameters" : {
1298 "additionalProperties" : 0,
1299 "properties" : {
1300 "ogroup" : {
1301 "description" : "Object Group ID.",
1302 "type" : "integer",
1303 "typetext" : "<integer>"
1304 }
1305 }
1306 },
1307 "proxyto" : "master",
1308 "returns" : {
1309 "items" : {
1310 "properties" : {
1311 "id" : {
1312 "type" : "integer"
1313 }
1314 },
1315 "type" : "object"
1316 },
1317 "links" : [
1318 {
1319 "href" : "{id}",
1320 "rel" : "child"
1321 }
1322 ],
1323 "type" : "array"
1324 }
1325 }
1326 },
1327 "leaf" : 0,
1328 "path" : "/config/ruledb/when/{ogroup}/objects",
1329 "text" : "objects"
1330 },
1331 {
1332 "children" : [
1333 {
1334 "info" : {
1335 "GET" : {
1336 "description" : "Read 'TimeFrame' object settings.",
1337 "method" : "GET",
1338 "name" : "read_timeframe",
1339 "parameters" : {
1340 "additionalProperties" : 0,
1341 "properties" : {
1342 "id" : {
1343 "description" : "Object ID.",
1344 "type" : "integer",
1345 "typetext" : "<integer>"
1346 },
1347 "ogroup" : {
1348 "description" : "Object Groups ID.",
1349 "type" : "integer",
1350 "typetext" : "<integer>"
1351 }
1352 }
1353 },
1354 "proxyto" : "master",
1355 "returns" : {
1356 "properties" : {
1357 "id" : {
1358 "type" : "integer"
1359 }
1360 },
1361 "type" : "object"
1362 }
1363 },
1364 "PUT" : {
1365 "description" : "Update 'TimeFrame' object.",
1366 "method" : "PUT",
1367 "name" : "update_timeframe",
1368 "parameters" : {
1369 "additionalProperties" : 0,
1370 "properties" : {
1371 "end" : {
1372 "description" : "End time in `H:i` format (00:00).",
1373 "pattern" : "\\d?\\d:\\d?\\d",
1374 "type" : "string"
1375 },
1376 "id" : {
1377 "description" : "Object ID.",
1378 "type" : "integer",
1379 "typetext" : "<integer>"
1380 },
1381 "ogroup" : {
1382 "description" : "Object Groups ID.",
1383 "type" : "integer",
1384 "typetext" : "<integer>"
1385 },
1386 "start" : {
1387 "description" : "Start time in `H:i` format (00:00).",
1388 "pattern" : "\\d?\\d:\\d?\\d",
1389 "type" : "string"
1390 }
1391 }
1392 },
1393 "protected" : 1,
1394 "proxyto" : "master",
1395 "returns" : {
1396 "type" : "null"
1397 }
1398 }
1399 },
1400 "leaf" : 1,
1401 "path" : "/config/ruledb/when/{ogroup}/timeframe/{id}",
1402 "text" : "{id}"
1403 }
1404 ],
1405 "info" : {
1406 "POST" : {
1407 "description" : "Add 'TimeFrame' object.",
1408 "method" : "POST",
1409 "name" : "timeframe",
1410 "parameters" : {
1411 "additionalProperties" : 0,
1412 "properties" : {
1413 "end" : {
1414 "description" : "End time in `H:i` format (00:00).",
1415 "pattern" : "\\d?\\d:\\d?\\d",
1416 "type" : "string"
1417 },
1418 "ogroup" : {
1419 "description" : "Object Groups ID.",
1420 "type" : "integer",
1421 "typetext" : "<integer>"
1422 },
1423 "start" : {
1424 "description" : "Start time in `H:i` format (00:00).",
1425 "pattern" : "\\d?\\d:\\d?\\d",
1426 "type" : "string"
1427 }
1428 }
1429 },
1430 "protected" : 1,
1431 "proxyto" : "master",
1432 "returns" : {
1433 "description" : "The object ID.",
1434 "type" : "integer"
1435 }
1436 }
1437 },
1438 "leaf" : 0,
1439 "path" : "/config/ruledb/when/{ogroup}/timeframe",
1440 "text" : "timeframe"
1441 }
1442 ],
1443 "info" : {
1444 "DELETE" : {
1445 "description" : "Delete a 'when' group.",
1446 "method" : "DELETE",
1447 "name" : "delete_{$oclass}_group",
1448 "parameters" : {
1449 "additionalProperties" : 0,
1450 "properties" : {
1451 "ogroup" : {
1452 "description" : "Object Group ID.",
1453 "type" : "integer",
1454 "typetext" : "<integer>"
1455 }
1456 }
1457 },
1458 "protected" : 1,
1459 "proxyto" : "master",
1460 "returns" : {
1461 "type" : "null"
1462 }
1463 },
1464 "GET" : {
1465 "description" : "Directory index.",
1466 "method" : "GET",
1467 "name" : "index",
1468 "parameters" : {
1469 "additionalProperties" : 0,
1470 "properties" : {
1471 "ogroup" : {
1472 "description" : "Object Group ID.",
1473 "type" : "integer",
1474 "typetext" : "<integer>"
1475 }
1476 }
1477 },
1478 "returns" : {
1479 "items" : {
1480 "properties" : {
1481 "subdir" : {
1482 "type" : "string"
1483 }
1484 },
1485 "type" : "object"
1486 },
1487 "links" : [
1488 {
1489 "href" : "{subdir}",
1490 "rel" : "child"
1491 }
1492 ],
1493 "type" : "array"
1494 }
1495 }
1496 },
1497 "leaf" : 0,
1498 "path" : "/config/ruledb/when/{ogroup}",
1499 "text" : "{ogroup}"
1500 }
1501 ],
1502 "info" : {
1503 "GET" : {
1504 "description" : "Get list of 'when' groups.",
1505 "method" : "GET",
1506 "name" : "list_when_groups",
1507 "parameters" : {
1508 "additionalProperties" : 0
1509 },
1510 "protected" : 1,
1511 "proxyto" : "master",
1512 "returns" : {
1513 "items" : {
1514 "properties" : {
1515 "id" : {
1516 "type" : "integer"
1517 }
1518 },
1519 "type" : "object"
1520 },
1521 "type" : "array"
1522 }
1523 },
1524 "POST" : {
1525 "description" : "Create a new 'when' group.",
1526 "method" : "POST",
1527 "name" : "create_when_group",
1528 "parameters" : {
1529 "additionalProperties" : 0,
1530 "properties" : {
1531 "info" : {
1532 "description" : "Informational comment.",
1533 "maxLength" : 255,
1534 "optional" : 1,
1535 "type" : "string",
1536 "typetext" : "<string>"
1537 },
1538 "name" : {
1539 "description" : "Group name.",
1540 "maxLength" : 255,
1541 "type" : "string",
1542 "typetext" : "<string>"
1543 }
1544 }
1545 },
1546 "protected" : 1,
1547 "proxyto" : "master",
1548 "returns" : {
1549 "type" : "integer"
1550 }
1551 }
1552 },
1553 "leaf" : 0,
1554 "path" : "/config/ruledb/when",
1555 "text" : "when"
1556 },
1557 {
1558 "children" : [
1559 {
1560 "children" : [
1561 {
1562 "info" : {
1563 "GET" : {
1564 "description" : "Get 'who' group properties",
1565 "method" : "GET",
1566 "name" : "get_config",
1567 "parameters" : {
1568 "additionalProperties" : 0,
1569 "properties" : {
1570 "ogroup" : {
1571 "description" : "Object Group ID.",
1572 "type" : "integer",
1573 "typetext" : "<integer>"
1574 }
1575 }
1576 },
1577 "proxyto" : "master",
1578 "returns" : {
1579 "properties" : {
1580 "id" : {
1581 "type" : "integer"
1582 },
1583 "info" : {
1584 "type" : "string"
1585 },
1586 "name" : {
1587 "type" : "string"
1588 }
1589 },
1590 "type" : "object"
1591 }
1592 },
1593 "PUT" : {
1594 "description" : "Modify 'who' group properties",
1595 "method" : "PUT",
1596 "name" : "set_config",
1597 "parameters" : {
1598 "additionalProperties" : 0,
1599 "properties" : {
1600 "info" : {
1601 "description" : "Informational comment.",
1602 "maxLength" : 255,
1603 "optional" : 1,
1604 "type" : "string",
1605 "typetext" : "<string>"
1606 },
1607 "name" : {
1608 "description" : "Group name.",
1609 "maxLength" : 255,
1610 "optional" : 1,
1611 "type" : "string",
1612 "typetext" : "<string>"
1613 },
1614 "ogroup" : {
1615 "description" : "Object Group ID.",
1616 "type" : "integer",
1617 "typetext" : "<integer>"
1618 }
1619 }
1620 },
1621 "proxyto" : "master",
1622 "returns" : {
1623 "type" : "null"
1624 }
1625 }
1626 },
1627 "leaf" : 1,
1628 "path" : "/config/ruledb/who/{ogroup}/config",
1629 "text" : "config"
1630 },
1631 {
1632 "children" : [
1633 {
1634 "info" : {
1635 "DELETE" : {
1636 "description" : "Remove an object from the 'who' group.",
1637 "method" : "DELETE",
1638 "name" : "delete_object",
1639 "parameters" : {
1640 "additionalProperties" : 0,
1641 "properties" : {
1642 "id" : {
1643 "description" : "Object ID.",
1644 "type" : "integer",
1645 "typetext" : "<integer>"
1646 },
1647 "ogroup" : {
1648 "description" : "Object Group ID.",
1649 "type" : "integer",
1650 "typetext" : "<integer>"
1651 }
1652 }
1653 },
1654 "protected" : 1,
1655 "proxyto" : "master",
1656 "returns" : {
1657 "type" : "null"
1658 }
1659 }
1660 },
1661 "leaf" : 1,
1662 "path" : "/config/ruledb/who/{ogroup}/objects/{id}",
1663 "text" : "{id}"
1664 }
1665 ],
1666 "info" : {
1667 "GET" : {
1668 "description" : "List 'who' group objects.",
1669 "method" : "GET",
1670 "name" : "objects",
1671 "parameters" : {
1672 "additionalProperties" : 0,
1673 "properties" : {
1674 "ogroup" : {
1675 "description" : "Object Group ID.",
1676 "type" : "integer",
1677 "typetext" : "<integer>"
1678 }
1679 }
1680 },
1681 "proxyto" : "master",
1682 "returns" : {
1683 "items" : {
1684 "properties" : {
1685 "id" : {
1686 "type" : "integer"
1687 }
1688 },
1689 "type" : "object"
1690 },
1691 "links" : [
1692 {
1693 "href" : "{id}",
1694 "rel" : "child"
1695 }
1696 ],
1697 "type" : "array"
1698 }
1699 }
1700 },
1701 "leaf" : 0,
1702 "path" : "/config/ruledb/who/{ogroup}/objects",
1703 "text" : "objects"
1704 },
1705 {
1706 "children" : [
1707 {
1708 "info" : {
1709 "GET" : {
1710 "description" : "Read 'Mail address' object settings.",
1711 "method" : "GET",
1712 "name" : "read_email",
1713 "parameters" : {
1714 "additionalProperties" : 0,
1715 "properties" : {
1716 "id" : {
1717 "description" : "Object ID.",
1718 "type" : "integer",
1719 "typetext" : "<integer>"
1720 },
1721 "ogroup" : {
1722 "description" : "Object Groups ID.",
1723 "type" : "integer",
1724 "typetext" : "<integer>"
1725 }
1726 }
1727 },
1728 "proxyto" : "master",
1729 "returns" : {
1730 "properties" : {
1731 "id" : {
1732 "type" : "integer"
1733 }
1734 },
1735 "type" : "object"
1736 }
1737 },
1738 "PUT" : {
1739 "description" : "Update 'Mail address' object.",
1740 "method" : "PUT",
1741 "name" : "update_email",
1742 "parameters" : {
1743 "additionalProperties" : 0,
1744 "properties" : {
1745 "email" : {
1746 "description" : "Email address.",
1747 "format" : "email",
1748 "type" : "string",
1749 "typetext" : "<string>"
1750 },
1751 "id" : {
1752 "description" : "Object ID.",
1753 "type" : "integer",
1754 "typetext" : "<integer>"
1755 },
1756 "ogroup" : {
1757 "description" : "Object Groups ID.",
1758 "type" : "integer",
1759 "typetext" : "<integer>"
1760 }
1761 }
1762 },
1763 "protected" : 1,
1764 "proxyto" : "master",
1765 "returns" : {
1766 "type" : "null"
1767 }
1768 }
1769 },
1770 "leaf" : 1,
1771 "path" : "/config/ruledb/who/{ogroup}/email/{id}",
1772 "text" : "{id}"
1773 }
1774 ],
1775 "info" : {
1776 "POST" : {
1777 "description" : "Add 'Mail address' object.",
1778 "method" : "POST",
1779 "name" : "email",
1780 "parameters" : {
1781 "additionalProperties" : 0,
1782 "properties" : {
1783 "email" : {
1784 "description" : "Email address.",
1785 "format" : "email",
1786 "type" : "string",
1787 "typetext" : "<string>"
1788 },
1789 "ogroup" : {
1790 "description" : "Object Groups ID.",
1791 "type" : "integer",
1792 "typetext" : "<integer>"
1793 }
1794 }
1795 },
1796 "protected" : 1,
1797 "proxyto" : "master",
1798 "returns" : {
1799 "description" : "The object ID.",
1800 "type" : "integer"
1801 }
1802 }
1803 },
1804 "leaf" : 0,
1805 "path" : "/config/ruledb/who/{ogroup}/email",
1806 "text" : "email"
1807 },
1808 {
1809 "children" : [
1810 {
1811 "info" : {
1812 "GET" : {
1813 "description" : "Read 'Domain' object settings.",
1814 "method" : "GET",
1815 "name" : "read_domain",
1816 "parameters" : {
1817 "additionalProperties" : 0,
1818 "properties" : {
1819 "id" : {
1820 "description" : "Object ID.",
1821 "type" : "integer",
1822 "typetext" : "<integer>"
1823 },
1824 "ogroup" : {
1825 "description" : "Object Groups ID.",
1826 "type" : "integer",
1827 "typetext" : "<integer>"
1828 }
1829 }
1830 },
1831 "proxyto" : "master",
1832 "returns" : {
1833 "properties" : {
1834 "id" : {
1835 "type" : "integer"
1836 }
1837 },
1838 "type" : "object"
1839 }
1840 },
1841 "PUT" : {
1842 "description" : "Update 'Domain' object.",
1843 "method" : "PUT",
1844 "name" : "update_domain",
1845 "parameters" : {
1846 "additionalProperties" : 0,
1847 "properties" : {
1848 "domain" : {
1849 "description" : "DNS domain name (Sender).",
1850 "format" : "dns-name",
1851 "type" : "string",
1852 "typetext" : "<string>"
1853 },
1854 "id" : {
1855 "description" : "Object ID.",
1856 "type" : "integer",
1857 "typetext" : "<integer>"
1858 },
1859 "ogroup" : {
1860 "description" : "Object Groups ID.",
1861 "type" : "integer",
1862 "typetext" : "<integer>"
1863 }
1864 }
1865 },
1866 "protected" : 1,
1867 "proxyto" : "master",
1868 "returns" : {
1869 "type" : "null"
1870 }
1871 }
1872 },
1873 "leaf" : 1,
1874 "path" : "/config/ruledb/who/{ogroup}/domain/{id}",
1875 "text" : "{id}"
1876 }
1877 ],
1878 "info" : {
1879 "POST" : {
1880 "description" : "Add 'Domain' object.",
1881 "method" : "POST",
1882 "name" : "domain",
1883 "parameters" : {
1884 "additionalProperties" : 0,
1885 "properties" : {
1886 "domain" : {
1887 "description" : "DNS domain name (Sender).",
1888 "format" : "dns-name",
1889 "type" : "string",
1890 "typetext" : "<string>"
1891 },
1892 "ogroup" : {
1893 "description" : "Object Groups ID.",
1894 "type" : "integer",
1895 "typetext" : "<integer>"
1896 }
1897 }
1898 },
1899 "protected" : 1,
1900 "proxyto" : "master",
1901 "returns" : {
1902 "description" : "The object ID.",
1903 "type" : "integer"
1904 }
1905 }
1906 },
1907 "leaf" : 0,
1908 "path" : "/config/ruledb/who/{ogroup}/domain",
1909 "text" : "domain"
1910 },
1911 {
1912 "children" : [
1913 {
1914 "info" : {
1915 "GET" : {
1916 "description" : "Read 'Regular Expression' object settings.",
1917 "method" : "GET",
1918 "name" : "read_regex",
1919 "parameters" : {
1920 "additionalProperties" : 0,
1921 "properties" : {
1922 "id" : {
1923 "description" : "Object ID.",
1924 "type" : "integer",
1925 "typetext" : "<integer>"
1926 },
1927 "ogroup" : {
1928 "description" : "Object Groups ID.",
1929 "type" : "integer",
1930 "typetext" : "<integer>"
1931 }
1932 }
1933 },
1934 "proxyto" : "master",
1935 "returns" : {
1936 "properties" : {
1937 "id" : {
1938 "type" : "integer"
1939 }
1940 },
1941 "type" : "object"
1942 }
1943 },
1944 "PUT" : {
1945 "description" : "Update 'Regular Expression' object.",
1946 "method" : "PUT",
1947 "name" : "update_regex",
1948 "parameters" : {
1949 "additionalProperties" : 0,
1950 "properties" : {
1951 "id" : {
1952 "description" : "Object ID.",
1953 "type" : "integer",
1954 "typetext" : "<integer>"
1955 },
1956 "ogroup" : {
1957 "description" : "Object Groups ID.",
1958 "type" : "integer",
1959 "typetext" : "<integer>"
1960 },
1961 "regex" : {
1962 "description" : "Email address regular expression.",
1963 "maxLength" : 1024,
1964 "type" : "string",
1965 "typetext" : "<string>"
1966 }
1967 }
1968 },
1969 "protected" : 1,
1970 "proxyto" : "master",
1971 "returns" : {
1972 "type" : "null"
1973 }
1974 }
1975 },
1976 "leaf" : 1,
1977 "path" : "/config/ruledb/who/{ogroup}/regex/{id}",
1978 "text" : "{id}"
1979 }
1980 ],
1981 "info" : {
1982 "POST" : {
1983 "description" : "Add 'Regular Expression' object.",
1984 "method" : "POST",
1985 "name" : "regex",
1986 "parameters" : {
1987 "additionalProperties" : 0,
1988 "properties" : {
1989 "ogroup" : {
1990 "description" : "Object Groups ID.",
1991 "type" : "integer",
1992 "typetext" : "<integer>"
1993 },
1994 "regex" : {
1995 "description" : "Email address regular expression.",
1996 "maxLength" : 1024,
1997 "type" : "string",
1998 "typetext" : "<string>"
1999 }
2000 }
2001 },
2002 "protected" : 1,
2003 "proxyto" : "master",
2004 "returns" : {
2005 "description" : "The object ID.",
2006 "type" : "integer"
2007 }
2008 }
2009 },
2010 "leaf" : 0,
2011 "path" : "/config/ruledb/who/{ogroup}/regex",
2012 "text" : "regex"
2013 },
2014 {
2015 "children" : [
2016 {
2017 "info" : {
2018 "GET" : {
2019 "description" : "Read 'IP Address' object settings.",
2020 "method" : "GET",
2021 "name" : "read_ip",
2022 "parameters" : {
2023 "additionalProperties" : 0,
2024 "properties" : {
2025 "id" : {
2026 "description" : "Object ID.",
2027 "type" : "integer",
2028 "typetext" : "<integer>"
2029 },
2030 "ogroup" : {
2031 "description" : "Object Groups ID.",
2032 "type" : "integer",
2033 "typetext" : "<integer>"
2034 }
2035 }
2036 },
2037 "proxyto" : "master",
2038 "returns" : {
2039 "properties" : {
2040 "id" : {
2041 "type" : "integer"
2042 }
2043 },
2044 "type" : "object"
2045 }
2046 },
2047 "PUT" : {
2048 "description" : "Update 'IP Address' object.",
2049 "method" : "PUT",
2050 "name" : "update_ip",
2051 "parameters" : {
2052 "additionalProperties" : 0,
2053 "properties" : {
2054 "id" : {
2055 "description" : "Object ID.",
2056 "type" : "integer",
2057 "typetext" : "<integer>"
2058 },
2059 "ip" : {
2060 "description" : "IP address",
2061 "format" : "ip",
2062 "type" : "string",
2063 "typetext" : "<string>"
2064 },
2065 "ogroup" : {
2066 "description" : "Object Groups ID.",
2067 "type" : "integer",
2068 "typetext" : "<integer>"
2069 }
2070 }
2071 },
2072 "protected" : 1,
2073 "proxyto" : "master",
2074 "returns" : {
2075 "type" : "null"
2076 }
2077 }
2078 },
2079 "leaf" : 1,
2080 "path" : "/config/ruledb/who/{ogroup}/ip/{id}",
2081 "text" : "{id}"
2082 }
2083 ],
2084 "info" : {
2085 "POST" : {
2086 "description" : "Add 'IP Address' object.",
2087 "method" : "POST",
2088 "name" : "ip",
2089 "parameters" : {
2090 "additionalProperties" : 0,
2091 "properties" : {
2092 "ip" : {
2093 "description" : "IP address",
2094 "format" : "ip",
2095 "type" : "string",
2096 "typetext" : "<string>"
2097 },
2098 "ogroup" : {
2099 "description" : "Object Groups ID.",
2100 "type" : "integer",
2101 "typetext" : "<integer>"
2102 }
2103 }
2104 },
2105 "protected" : 1,
2106 "proxyto" : "master",
2107 "returns" : {
2108 "description" : "The object ID.",
2109 "type" : "integer"
2110 }
2111 }
2112 },
2113 "leaf" : 0,
2114 "path" : "/config/ruledb/who/{ogroup}/ip",
2115 "text" : "ip"
2116 },
2117 {
2118 "children" : [
2119 {
2120 "info" : {
2121 "GET" : {
2122 "description" : "Read 'IP Network' object settings.",
2123 "method" : "GET",
2124 "name" : "read_network",
2125 "parameters" : {
2126 "additionalProperties" : 0,
2127 "properties" : {
2128 "id" : {
2129 "description" : "Object ID.",
2130 "type" : "integer",
2131 "typetext" : "<integer>"
2132 },
2133 "ogroup" : {
2134 "description" : "Object Groups ID.",
2135 "type" : "integer",
2136 "typetext" : "<integer>"
2137 }
2138 }
2139 },
2140 "proxyto" : "master",
2141 "returns" : {
2142 "properties" : {
2143 "id" : {
2144 "type" : "integer"
2145 }
2146 },
2147 "type" : "object"
2148 }
2149 },
2150 "PUT" : {
2151 "description" : "Update 'IP Network' object.",
2152 "method" : "PUT",
2153 "name" : "update_network",
2154 "parameters" : {
2155 "additionalProperties" : 0,
2156 "properties" : {
2157 "cidr" : {
2158 "description" : "Network address in CIDR notation.",
2159 "format" : "CIDR",
2160 "type" : "string",
2161 "typetext" : "<string>"
2162 },
2163 "id" : {
2164 "description" : "Object ID.",
2165 "type" : "integer",
2166 "typetext" : "<integer>"
2167 },
2168 "ogroup" : {
2169 "description" : "Object Groups ID.",
2170 "type" : "integer",
2171 "typetext" : "<integer>"
2172 }
2173 }
2174 },
2175 "protected" : 1,
2176 "proxyto" : "master",
2177 "returns" : {
2178 "type" : "null"
2179 }
2180 }
2181 },
2182 "leaf" : 1,
2183 "path" : "/config/ruledb/who/{ogroup}/network/{id}",
2184 "text" : "{id}"
2185 }
2186 ],
2187 "info" : {
2188 "POST" : {
2189 "description" : "Add 'IP Network' object.",
2190 "method" : "POST",
2191 "name" : "network",
2192 "parameters" : {
2193 "additionalProperties" : 0,
2194 "properties" : {
2195 "cidr" : {
2196 "description" : "Network address in CIDR notation.",
2197 "format" : "CIDR",
2198 "type" : "string",
2199 "typetext" : "<string>"
2200 },
2201 "ogroup" : {
2202 "description" : "Object Groups ID.",
2203 "type" : "integer",
2204 "typetext" : "<integer>"
2205 }
2206 }
2207 },
2208 "protected" : 1,
2209 "proxyto" : "master",
2210 "returns" : {
2211 "description" : "The object ID.",
2212 "type" : "integer"
2213 }
2214 }
2215 },
2216 "leaf" : 0,
2217 "path" : "/config/ruledb/who/{ogroup}/network",
2218 "text" : "network"
2219 },
2220 {
2221 "children" : [
2222 {
2223 "info" : {
2224 "GET" : {
2225 "description" : "Read 'LDAP Group' object settings.",
2226 "method" : "GET",
2227 "name" : "read_ldap",
2228 "parameters" : {
2229 "additionalProperties" : 0,
2230 "properties" : {
2231 "id" : {
2232 "description" : "Object ID.",
2233 "type" : "integer",
2234 "typetext" : "<integer>"
2235 },
2236 "ogroup" : {
2237 "description" : "Object Groups ID.",
2238 "type" : "integer",
2239 "typetext" : "<integer>"
2240 }
2241 }
2242 },
2243 "proxyto" : "master",
2244 "returns" : {
2245 "properties" : {
2246 "id" : {
2247 "type" : "integer"
2248 }
2249 },
2250 "type" : "object"
2251 }
2252 },
2253 "PUT" : {
2254 "description" : "Update 'LDAP Group' object.",
2255 "method" : "PUT",
2256 "name" : "update_ldap",
2257 "parameters" : {
2258 "additionalProperties" : 0,
2259 "properties" : {
2260 "group" : {
2261 "description" : "LDAP Group DN",
2262 "maxLength" : 1024,
2263 "minLength" : 1,
2264 "optional" : 1,
2265 "type" : "string",
2266 "typetext" : "<string>"
2267 },
2268 "id" : {
2269 "description" : "Object ID.",
2270 "type" : "integer",
2271 "typetext" : "<integer>"
2272 },
2273 "mode" : {
2274 "description" : "Operational mode. You can either match 'any' user, match when no such user exists with 'none', or match when the user is member of a specific group.",
2275 "enum" : [
2276 "any",
2277 "none",
2278 "group"
2279 ],
2280 "type" : "string"
2281 },
2282 "ogroup" : {
2283 "description" : "Object Groups ID.",
2284 "type" : "integer",
2285 "typetext" : "<integer>"
2286 },
2287 "profile" : {
2288 "description" : "Profile ID.",
2289 "format" : "pve-configid",
2290 "optional" : 1,
2291 "type" : "string",
2292 "typetext" : "<string>"
2293 }
2294 }
2295 },
2296 "protected" : 1,
2297 "proxyto" : "master",
2298 "returns" : {
2299 "type" : "null"
2300 }
2301 }
2302 },
2303 "leaf" : 1,
2304 "path" : "/config/ruledb/who/{ogroup}/ldap/{id}",
2305 "text" : "{id}"
2306 }
2307 ],
2308 "info" : {
2309 "POST" : {
2310 "description" : "Add 'LDAP Group' object.",
2311 "method" : "POST",
2312 "name" : "ldap",
2313 "parameters" : {
2314 "additionalProperties" : 0,
2315 "properties" : {
2316 "group" : {
2317 "description" : "LDAP Group DN",
2318 "maxLength" : 1024,
2319 "minLength" : 1,
2320 "optional" : 1,
2321 "type" : "string",
2322 "typetext" : "<string>"
2323 },
2324 "mode" : {
2325 "description" : "Operational mode. You can either match 'any' user, match when no such user exists with 'none', or match when the user is member of a specific group.",
2326 "enum" : [
2327 "any",
2328 "none",
2329 "group"
2330 ],
2331 "type" : "string"
2332 },
2333 "ogroup" : {
2334 "description" : "Object Groups ID.",
2335 "type" : "integer",
2336 "typetext" : "<integer>"
2337 },
2338 "profile" : {
2339 "description" : "Profile ID.",
2340 "format" : "pve-configid",
2341 "optional" : 1,
2342 "type" : "string",
2343 "typetext" : "<string>"
2344 }
2345 }
2346 },
2347 "protected" : 1,
2348 "proxyto" : "master",
2349 "returns" : {
2350 "description" : "The object ID.",
2351 "type" : "integer"
2352 }
2353 }
2354 },
2355 "leaf" : 0,
2356 "path" : "/config/ruledb/who/{ogroup}/ldap",
2357 "text" : "ldap"
2358 },
2359 {
2360 "children" : [
2361 {
2362 "info" : {
2363 "GET" : {
2364 "description" : "Read 'LDAP User' object settings.",
2365 "method" : "GET",
2366 "name" : "read_ldapuser",
2367 "parameters" : {
2368 "additionalProperties" : 0,
2369 "properties" : {
2370 "id" : {
2371 "description" : "Object ID.",
2372 "type" : "integer",
2373 "typetext" : "<integer>"
2374 },
2375 "ogroup" : {
2376 "description" : "Object Groups ID.",
2377 "type" : "integer",
2378 "typetext" : "<integer>"
2379 }
2380 }
2381 },
2382 "proxyto" : "master",
2383 "returns" : {
2384 "properties" : {
2385 "id" : {
2386 "type" : "integer"
2387 }
2388 },
2389 "type" : "object"
2390 }
2391 },
2392 "PUT" : {
2393 "description" : "Update 'LDAP User' object.",
2394 "method" : "PUT",
2395 "name" : "update_ldapuser",
2396 "parameters" : {
2397 "additionalProperties" : 0,
2398 "properties" : {
2399 "account" : {
2400 "description" : "LDAP user account name.",
2401 "maxLength" : 1024,
2402 "minLength" : 1,
2403 "type" : "string",
2404 "typetext" : "<string>"
2405 },
2406 "id" : {
2407 "description" : "Object ID.",
2408 "type" : "integer",
2409 "typetext" : "<integer>"
2410 },
2411 "ogroup" : {
2412 "description" : "Object Groups ID.",
2413 "type" : "integer",
2414 "typetext" : "<integer>"
2415 },
2416 "profile" : {
2417 "description" : "Profile ID.",
2418 "format" : "pve-configid",
2419 "type" : "string",
2420 "typetext" : "<string>"
2421 }
2422 }
2423 },
2424 "protected" : 1,
2425 "proxyto" : "master",
2426 "returns" : {
2427 "type" : "null"
2428 }
2429 }
2430 },
2431 "leaf" : 1,
2432 "path" : "/config/ruledb/who/{ogroup}/ldapuser/{id}",
2433 "text" : "{id}"
2434 }
2435 ],
2436 "info" : {
2437 "POST" : {
2438 "description" : "Add 'LDAP User' object.",
2439 "method" : "POST",
2440 "name" : "ldapuser",
2441 "parameters" : {
2442 "additionalProperties" : 0,
2443 "properties" : {
2444 "account" : {
2445 "description" : "LDAP user account name.",
2446 "maxLength" : 1024,
2447 "minLength" : 1,
2448 "type" : "string",
2449 "typetext" : "<string>"
2450 },
2451 "ogroup" : {
2452 "description" : "Object Groups ID.",
2453 "type" : "integer",
2454 "typetext" : "<integer>"
2455 },
2456 "profile" : {
2457 "description" : "Profile ID.",
2458 "format" : "pve-configid",
2459 "type" : "string",
2460 "typetext" : "<string>"
2461 }
2462 }
2463 },
2464 "protected" : 1,
2465 "proxyto" : "master",
2466 "returns" : {
2467 "description" : "The object ID.",
2468 "type" : "integer"
2469 }
2470 }
2471 },
2472 "leaf" : 0,
2473 "path" : "/config/ruledb/who/{ogroup}/ldapuser",
2474 "text" : "ldapuser"
2475 }
2476 ],
2477 "info" : {
2478 "DELETE" : {
2479 "description" : "Delete a 'who' group.",
2480 "method" : "DELETE",
2481 "name" : "delete_{$oclass}_group",
2482 "parameters" : {
2483 "additionalProperties" : 0,
2484 "properties" : {
2485 "ogroup" : {
2486 "description" : "Object Group ID.",
2487 "type" : "integer",
2488 "typetext" : "<integer>"
2489 }
2490 }
2491 },
2492 "protected" : 1,
2493 "proxyto" : "master",
2494 "returns" : {
2495 "type" : "null"
2496 }
2497 },
2498 "GET" : {
2499 "description" : "Directory index.",
2500 "method" : "GET",
2501 "name" : "index",
2502 "parameters" : {
2503 "additionalProperties" : 0,
2504 "properties" : {
2505 "ogroup" : {
2506 "description" : "Object Group ID.",
2507 "type" : "integer",
2508 "typetext" : "<integer>"
2509 }
2510 }
2511 },
2512 "returns" : {
2513 "items" : {
2514 "properties" : {
2515 "subdir" : {
2516 "type" : "string"
2517 }
2518 },
2519 "type" : "object"
2520 },
2521 "links" : [
2522 {
2523 "href" : "{subdir}",
2524 "rel" : "child"
2525 }
2526 ],
2527 "type" : "array"
2528 }
2529 }
2530 },
2531 "leaf" : 0,
2532 "path" : "/config/ruledb/who/{ogroup}",
2533 "text" : "{ogroup}"
2534 }
2535 ],
2536 "info" : {
2537 "GET" : {
2538 "description" : "Get list of 'who' groups.",
2539 "method" : "GET",
2540 "name" : "list_who_groups",
2541 "parameters" : {
2542 "additionalProperties" : 0
2543 },
2544 "protected" : 1,
2545 "proxyto" : "master",
2546 "returns" : {
2547 "items" : {
2548 "properties" : {
2549 "id" : {
2550 "type" : "integer"
2551 }
2552 },
2553 "type" : "object"
2554 },
2555 "type" : "array"
2556 }
2557 },
2558 "POST" : {
2559 "description" : "Create a new 'who' group.",
2560 "method" : "POST",
2561 "name" : "create_who_group",
2562 "parameters" : {
2563 "additionalProperties" : 0,
2564 "properties" : {
2565 "info" : {
2566 "description" : "Informational comment.",
2567 "maxLength" : 255,
2568 "optional" : 1,
2569 "type" : "string",
2570 "typetext" : "<string>"
2571 },
2572 "name" : {
2573 "description" : "Group name.",
2574 "maxLength" : 255,
2575 "type" : "string",
2576 "typetext" : "<string>"
2577 }
2578 }
2579 },
2580 "protected" : 1,
2581 "proxyto" : "master",
2582 "returns" : {
2583 "type" : "integer"
2584 }
2585 }
2586 },
2587 "leaf" : 0,
2588 "path" : "/config/ruledb/who",
2589 "text" : "who"
2590 }
2591 ],
2592 "info" : {
2593 "GET" : {
2594 "description" : "Directory index.",
2595 "method" : "GET",
2596 "name" : "index",
2597 "parameters" : {
2598 "additionalProperties" : 0
2599 },
2600 "returns" : {
2601 "items" : {
2602 "properties" : {},
2603 "type" : "object"
2604 },
2605 "links" : [
2606 {
2607 "href" : "{name}",
2608 "rel" : "child"
2609 }
2610 ],
2611 "type" : "array"
2612 }
2613 }
2614 },
2615 "leaf" : 0,
2616 "path" : "/config/ruledb",
2617 "text" : "ruledb"
2618 },
2619 {
2620 "children" : [
2621 {
2622 "children" : [
2623 {
2624 "info" : {
2625 "DELETE" : {
2626 "description" : "Remove an object from the SMTP whitelist.",
2627 "method" : "DELETE",
2628 "name" : "delete_object",
2629 "parameters" : {
2630 "additionalProperties" : 0,
2631 "properties" : {
2632 "id" : {
2633 "description" : "Object ID.",
2634 "type" : "integer",
2635 "typetext" : "<integer>"
2636 }
2637 }
2638 },
2639 "proxyto" : "master",
2640 "returns" : {
2641 "type" : "null"
2642 }
2643 }
2644 },
2645 "leaf" : 1,
2646 "path" : "/config/whitelist/objects/{id}",
2647 "text" : "{id}"
2648 }
2649 ],
2650 "info" : {
2651 "GET" : {
2652 "description" : "Get list of all SMTP whitelist entries.",
2653 "method" : "GET",
2654 "name" : "objects",
2655 "parameters" : {
2656 "additionalProperties" : 0
2657 },
2658 "proxyto" : "master",
2659 "returns" : {
2660 "items" : {
2661 "properties" : {
2662 "id" : {
2663 "type" : "integer"
2664 }
2665 },
2666 "type" : "object"
2667 },
2668 "links" : [
2669 {
2670 "href" : "{id}",
2671 "rel" : "child"
2672 }
2673 ],
2674 "type" : "array"
2675 }
2676 }
2677 },
2678 "leaf" : 0,
2679 "path" : "/config/whitelist/objects",
2680 "text" : "objects"
2681 },
2682 {
2683 "children" : [
2684 {
2685 "info" : {
2686 "GET" : {
2687 "description" : "Read 'Mail address' object settings.",
2688 "method" : "GET",
2689 "name" : "read_email",
2690 "parameters" : {
2691 "additionalProperties" : 0,
2692 "properties" : {
2693 "id" : {
2694 "description" : "Object ID.",
2695 "type" : "integer",
2696 "typetext" : "<integer>"
2697 }
2698 }
2699 },
2700 "proxyto" : "master",
2701 "returns" : {
2702 "properties" : {
2703 "id" : {
2704 "type" : "integer"
2705 }
2706 },
2707 "type" : "object"
2708 }
2709 },
2710 "PUT" : {
2711 "description" : "Update 'Mail address' object.",
2712 "method" : "PUT",
2713 "name" : "update_email",
2714 "parameters" : {
2715 "additionalProperties" : 0,
2716 "properties" : {
2717 "email" : {
2718 "description" : "Email address.",
2719 "format" : "email",
2720 "type" : "string",
2721 "typetext" : "<string>"
2722 },
2723 "id" : {
2724 "description" : "Object ID.",
2725 "type" : "integer",
2726 "typetext" : "<integer>"
2727 }
2728 }
2729 },
2730 "protected" : 1,
2731 "proxyto" : "master",
2732 "returns" : {
2733 "type" : "null"
2734 }
2735 }
2736 },
2737 "leaf" : 1,
2738 "path" : "/config/whitelist/email/{id}",
2739 "text" : "{id}"
2740 }
2741 ],
2742 "info" : {
2743 "POST" : {
2744 "description" : "Add 'Mail address' object.",
2745 "method" : "POST",
2746 "name" : "email",
2747 "parameters" : {
2748 "additionalProperties" : 0,
2749 "properties" : {
2750 "email" : {
2751 "description" : "Email address.",
2752 "format" : "email",
2753 "type" : "string",
2754 "typetext" : "<string>"
2755 }
2756 }
2757 },
2758 "protected" : 1,
2759 "proxyto" : "master",
2760 "returns" : {
2761 "description" : "The object ID.",
2762 "type" : "integer"
2763 }
2764 }
2765 },
2766 "leaf" : 0,
2767 "path" : "/config/whitelist/email",
2768 "text" : "email"
2769 },
2770 {
2771 "children" : [
2772 {
2773 "info" : {
2774 "GET" : {
2775 "description" : "Read 'Mail address' object settings.",
2776 "method" : "GET",
2777 "name" : "read_receiver",
2778 "parameters" : {
2779 "additionalProperties" : 0,
2780 "properties" : {
2781 "id" : {
2782 "description" : "Object ID.",
2783 "type" : "integer",
2784 "typetext" : "<integer>"
2785 }
2786 }
2787 },
2788 "proxyto" : "master",
2789 "returns" : {
2790 "properties" : {
2791 "id" : {
2792 "type" : "integer"
2793 }
2794 },
2795 "type" : "object"
2796 }
2797 },
2798 "PUT" : {
2799 "description" : "Update 'Mail address' object.",
2800 "method" : "PUT",
2801 "name" : "update_receiver",
2802 "parameters" : {
2803 "additionalProperties" : 0,
2804 "properties" : {
2805 "email" : {
2806 "description" : "Email address.",
2807 "format" : "email",
2808 "type" : "string",
2809 "typetext" : "<string>"
2810 },
2811 "id" : {
2812 "description" : "Object ID.",
2813 "type" : "integer",
2814 "typetext" : "<integer>"
2815 }
2816 }
2817 },
2818 "protected" : 1,
2819 "proxyto" : "master",
2820 "returns" : {
2821 "type" : "null"
2822 }
2823 }
2824 },
2825 "leaf" : 1,
2826 "path" : "/config/whitelist/receiver/{id}",
2827 "text" : "{id}"
2828 }
2829 ],
2830 "info" : {
2831 "POST" : {
2832 "description" : "Add 'Mail address' object.",
2833 "method" : "POST",
2834 "name" : "receiver",
2835 "parameters" : {
2836 "additionalProperties" : 0,
2837 "properties" : {
2838 "email" : {
2839 "description" : "Email address.",
2840 "format" : "email",
2841 "type" : "string",
2842 "typetext" : "<string>"
2843 }
2844 }
2845 },
2846 "protected" : 1,
2847 "proxyto" : "master",
2848 "returns" : {
2849 "description" : "The object ID.",
2850 "type" : "integer"
2851 }
2852 }
2853 },
2854 "leaf" : 0,
2855 "path" : "/config/whitelist/receiver",
2856 "text" : "receiver"
2857 },
2858 {
2859 "children" : [
2860 {
2861 "info" : {
2862 "GET" : {
2863 "description" : "Read 'Domain' object settings.",
2864 "method" : "GET",
2865 "name" : "read_domain",
2866 "parameters" : {
2867 "additionalProperties" : 0,
2868 "properties" : {
2869 "id" : {
2870 "description" : "Object ID.",
2871 "type" : "integer",
2872 "typetext" : "<integer>"
2873 }
2874 }
2875 },
2876 "proxyto" : "master",
2877 "returns" : {
2878 "properties" : {
2879 "id" : {
2880 "type" : "integer"
2881 }
2882 },
2883 "type" : "object"
2884 }
2885 },
2886 "PUT" : {
2887 "description" : "Update 'Domain' object.",
2888 "method" : "PUT",
2889 "name" : "update_domain",
2890 "parameters" : {
2891 "additionalProperties" : 0,
2892 "properties" : {
2893 "domain" : {
2894 "description" : "DNS domain name (Sender).",
2895 "format" : "dns-name",
2896 "type" : "string",
2897 "typetext" : "<string>"
2898 },
2899 "id" : {
2900 "description" : "Object ID.",
2901 "type" : "integer",
2902 "typetext" : "<integer>"
2903 }
2904 }
2905 },
2906 "protected" : 1,
2907 "proxyto" : "master",
2908 "returns" : {
2909 "type" : "null"
2910 }
2911 }
2912 },
2913 "leaf" : 1,
2914 "path" : "/config/whitelist/domain/{id}",
2915 "text" : "{id}"
2916 }
2917 ],
2918 "info" : {
2919 "POST" : {
2920 "description" : "Add 'Domain' object.",
2921 "method" : "POST",
2922 "name" : "domain",
2923 "parameters" : {
2924 "additionalProperties" : 0,
2925 "properties" : {
2926 "domain" : {
2927 "description" : "DNS domain name (Sender).",
2928 "format" : "dns-name",
2929 "type" : "string",
2930 "typetext" : "<string>"
2931 }
2932 }
2933 },
2934 "protected" : 1,
2935 "proxyto" : "master",
2936 "returns" : {
2937 "description" : "The object ID.",
2938 "type" : "integer"
2939 }
2940 }
2941 },
2942 "leaf" : 0,
2943 "path" : "/config/whitelist/domain",
2944 "text" : "domain"
2945 },
2946 {
2947 "children" : [
2948 {
2949 "info" : {
2950 "GET" : {
2951 "description" : "Read 'Domain' object settings.",
2952 "method" : "GET",
2953 "name" : "read_receiver_domain",
2954 "parameters" : {
2955 "additionalProperties" : 0,
2956 "properties" : {
2957 "id" : {
2958 "description" : "Object ID.",
2959 "type" : "integer",
2960 "typetext" : "<integer>"
2961 }
2962 }
2963 },
2964 "proxyto" : "master",
2965 "returns" : {
2966 "properties" : {
2967 "id" : {
2968 "type" : "integer"
2969 }
2970 },
2971 "type" : "object"
2972 }
2973 },
2974 "PUT" : {
2975 "description" : "Update 'Domain' object.",
2976 "method" : "PUT",
2977 "name" : "update_receiver_domain",
2978 "parameters" : {
2979 "additionalProperties" : 0,
2980 "properties" : {
2981 "domain" : {
2982 "description" : "DNS domain name (Sender).",
2983 "format" : "dns-name",
2984 "type" : "string",
2985 "typetext" : "<string>"
2986 },
2987 "id" : {
2988 "description" : "Object ID.",
2989 "type" : "integer",
2990 "typetext" : "<integer>"
2991 }
2992 }
2993 },
2994 "protected" : 1,
2995 "proxyto" : "master",
2996 "returns" : {
2997 "type" : "null"
2998 }
2999 }
3000 },
3001 "leaf" : 1,
3002 "path" : "/config/whitelist/receiver_domain/{id}",
3003 "text" : "{id}"
3004 }
3005 ],
3006 "info" : {
3007 "POST" : {
3008 "description" : "Add 'Domain' object.",
3009 "method" : "POST",
3010 "name" : "receiver_domain",
3011 "parameters" : {
3012 "additionalProperties" : 0,
3013 "properties" : {
3014 "domain" : {
3015 "description" : "DNS domain name (Sender).",
3016 "format" : "dns-name",
3017 "type" : "string",
3018 "typetext" : "<string>"
3019 }
3020 }
3021 },
3022 "protected" : 1,
3023 "proxyto" : "master",
3024 "returns" : {
3025 "description" : "The object ID.",
3026 "type" : "integer"
3027 }
3028 }
3029 },
3030 "leaf" : 0,
3031 "path" : "/config/whitelist/receiver_domain",
3032 "text" : "receiver_domain"
3033 },
3034 {
3035 "children" : [
3036 {
3037 "info" : {
3038 "GET" : {
3039 "description" : "Read 'Regular Expression' object settings.",
3040 "method" : "GET",
3041 "name" : "read_regex",
3042 "parameters" : {
3043 "additionalProperties" : 0,
3044 "properties" : {
3045 "id" : {
3046 "description" : "Object ID.",
3047 "type" : "integer",
3048 "typetext" : "<integer>"
3049 }
3050 }
3051 },
3052 "proxyto" : "master",
3053 "returns" : {
3054 "properties" : {
3055 "id" : {
3056 "type" : "integer"
3057 }
3058 },
3059 "type" : "object"
3060 }
3061 },
3062 "PUT" : {
3063 "description" : "Update 'Regular Expression' object.",
3064 "method" : "PUT",
3065 "name" : "update_regex",
3066 "parameters" : {
3067 "additionalProperties" : 0,
3068 "properties" : {
3069 "id" : {
3070 "description" : "Object ID.",
3071 "type" : "integer",
3072 "typetext" : "<integer>"
3073 },
3074 "regex" : {
3075 "description" : "Email address regular expression.",
3076 "maxLength" : 1024,
3077 "type" : "string",
3078 "typetext" : "<string>"
3079 }
3080 }
3081 },
3082 "protected" : 1,
3083 "proxyto" : "master",
3084 "returns" : {
3085 "type" : "null"
3086 }
3087 }
3088 },
3089 "leaf" : 1,
3090 "path" : "/config/whitelist/regex/{id}",
3091 "text" : "{id}"
3092 }
3093 ],
3094 "info" : {
3095 "POST" : {
3096 "description" : "Add 'Regular Expression' object.",
3097 "method" : "POST",
3098 "name" : "regex",
3099 "parameters" : {
3100 "additionalProperties" : 0,
3101 "properties" : {
3102 "regex" : {
3103 "description" : "Email address regular expression.",
3104 "maxLength" : 1024,
3105 "type" : "string",
3106 "typetext" : "<string>"
3107 }
3108 }
3109 },
3110 "protected" : 1,
3111 "proxyto" : "master",
3112 "returns" : {
3113 "description" : "The object ID.",
3114 "type" : "integer"
3115 }
3116 }
3117 },
3118 "leaf" : 0,
3119 "path" : "/config/whitelist/regex",
3120 "text" : "regex"
3121 },
3122 {
3123 "children" : [
3124 {
3125 "info" : {
3126 "GET" : {
3127 "description" : "Read 'Regular Expression' object settings.",
3128 "method" : "GET",
3129 "name" : "read_receiver_regex",
3130 "parameters" : {
3131 "additionalProperties" : 0,
3132 "properties" : {
3133 "id" : {
3134 "description" : "Object ID.",
3135 "type" : "integer",
3136 "typetext" : "<integer>"
3137 }
3138 }
3139 },
3140 "proxyto" : "master",
3141 "returns" : {
3142 "properties" : {
3143 "id" : {
3144 "type" : "integer"
3145 }
3146 },
3147 "type" : "object"
3148 }
3149 },
3150 "PUT" : {
3151 "description" : "Update 'Regular Expression' object.",
3152 "method" : "PUT",
3153 "name" : "update_receiver_regex",
3154 "parameters" : {
3155 "additionalProperties" : 0,
3156 "properties" : {
3157 "id" : {
3158 "description" : "Object ID.",
3159 "type" : "integer",
3160 "typetext" : "<integer>"
3161 },
3162 "regex" : {
3163 "description" : "Email address regular expression.",
3164 "maxLength" : 1024,
3165 "type" : "string",
3166 "typetext" : "<string>"
3167 }
3168 }
3169 },
3170 "protected" : 1,
3171 "proxyto" : "master",
3172 "returns" : {
3173 "type" : "null"
3174 }
3175 }
3176 },
3177 "leaf" : 1,
3178 "path" : "/config/whitelist/receiver_regex/{id}",
3179 "text" : "{id}"
3180 }
3181 ],
3182 "info" : {
3183 "POST" : {
3184 "description" : "Add 'Regular Expression' object.",
3185 "method" : "POST",
3186 "name" : "receiver_regex",
3187 "parameters" : {
3188 "additionalProperties" : 0,
3189 "properties" : {
3190 "regex" : {
3191 "description" : "Email address regular expression.",
3192 "maxLength" : 1024,
3193 "type" : "string",
3194 "typetext" : "<string>"
3195 }
3196 }
3197 },
3198 "protected" : 1,
3199 "proxyto" : "master",
3200 "returns" : {
3201 "description" : "The object ID.",
3202 "type" : "integer"
3203 }
3204 }
3205 },
3206 "leaf" : 0,
3207 "path" : "/config/whitelist/receiver_regex",
3208 "text" : "receiver_regex"
3209 },
3210 {
3211 "children" : [
3212 {
3213 "info" : {
3214 "GET" : {
3215 "description" : "Read 'IP Address' object settings.",
3216 "method" : "GET",
3217 "name" : "read_ip",
3218 "parameters" : {
3219 "additionalProperties" : 0,
3220 "properties" : {
3221 "id" : {
3222 "description" : "Object ID.",
3223 "type" : "integer",
3224 "typetext" : "<integer>"
3225 }
3226 }
3227 },
3228 "proxyto" : "master",
3229 "returns" : {
3230 "properties" : {
3231 "id" : {
3232 "type" : "integer"
3233 }
3234 },
3235 "type" : "object"
3236 }
3237 },
3238 "PUT" : {
3239 "description" : "Update 'IP Address' object.",
3240 "method" : "PUT",
3241 "name" : "update_ip",
3242 "parameters" : {
3243 "additionalProperties" : 0,
3244 "properties" : {
3245 "id" : {
3246 "description" : "Object ID.",
3247 "type" : "integer",
3248 "typetext" : "<integer>"
3249 },
3250 "ip" : {
3251 "description" : "IP address",
3252 "format" : "ip",
3253 "type" : "string",
3254 "typetext" : "<string>"
3255 }
3256 }
3257 },
3258 "protected" : 1,
3259 "proxyto" : "master",
3260 "returns" : {
3261 "type" : "null"
3262 }
3263 }
3264 },
3265 "leaf" : 1,
3266 "path" : "/config/whitelist/ip/{id}",
3267 "text" : "{id}"
3268 }
3269 ],
3270 "info" : {
3271 "POST" : {
3272 "description" : "Add 'IP Address' object.",
3273 "method" : "POST",
3274 "name" : "ip",
3275 "parameters" : {
3276 "additionalProperties" : 0,
3277 "properties" : {
3278 "ip" : {
3279 "description" : "IP address",
3280 "format" : "ip",
3281 "type" : "string",
3282 "typetext" : "<string>"
3283 }
3284 }
3285 },
3286 "protected" : 1,
3287 "proxyto" : "master",
3288 "returns" : {
3289 "description" : "The object ID.",
3290 "type" : "integer"
3291 }
3292 }
3293 },
3294 "leaf" : 0,
3295 "path" : "/config/whitelist/ip",
3296 "text" : "ip"
3297 },
3298 {
3299 "children" : [
3300 {
3301 "info" : {
3302 "GET" : {
3303 "description" : "Read 'IP Network' object settings.",
3304 "method" : "GET",
3305 "name" : "read_network",
3306 "parameters" : {
3307 "additionalProperties" : 0,
3308 "properties" : {
3309 "id" : {
3310 "description" : "Object ID.",
3311 "type" : "integer",
3312 "typetext" : "<integer>"
3313 }
3314 }
3315 },
3316 "proxyto" : "master",
3317 "returns" : {
3318 "properties" : {
3319 "id" : {
3320 "type" : "integer"
3321 }
3322 },
3323 "type" : "object"
3324 }
3325 },
3326 "PUT" : {
3327 "description" : "Update 'IP Network' object.",
3328 "method" : "PUT",
3329 "name" : "update_network",
3330 "parameters" : {
3331 "additionalProperties" : 0,
3332 "properties" : {
3333 "cidr" : {
3334 "description" : "Network address in CIDR notation.",
3335 "format" : "CIDR",
3336 "type" : "string",
3337 "typetext" : "<string>"
3338 },
3339 "id" : {
3340 "description" : "Object ID.",
3341 "type" : "integer",
3342 "typetext" : "<integer>"
3343 }
3344 }
3345 },
3346 "protected" : 1,
3347 "proxyto" : "master",
3348 "returns" : {
3349 "type" : "null"
3350 }
3351 }
3352 },
3353 "leaf" : 1,
3354 "path" : "/config/whitelist/network/{id}",
3355 "text" : "{id}"
3356 }
3357 ],
3358 "info" : {
3359 "POST" : {
3360 "description" : "Add 'IP Network' object.",
3361 "method" : "POST",
3362 "name" : "network",
3363 "parameters" : {
3364 "additionalProperties" : 0,
3365 "properties" : {
3366 "cidr" : {
3367 "description" : "Network address in CIDR notation.",
3368 "format" : "CIDR",
3369 "type" : "string",
3370 "typetext" : "<string>"
3371 }
3372 }
3373 },
3374 "protected" : 1,
3375 "proxyto" : "master",
3376 "returns" : {
3377 "description" : "The object ID.",
3378 "type" : "integer"
3379 }
3380 }
3381 },
3382 "leaf" : 0,
3383 "path" : "/config/whitelist/network",
3384 "text" : "network"
3385 }
3386 ],
3387 "info" : {
3388 "GET" : {
3389 "description" : "Directory index.",
3390 "method" : "GET",
3391 "name" : "index",
3392 "parameters" : {
3393 "additionalProperties" : 0
3394 },
3395 "returns" : {
3396 "items" : {
3397 "properties" : {
3398 "subdir" : {
3399 "type" : "string"
3400 }
3401 },
3402 "type" : "object"
3403 },
3404 "links" : [
3405 {
3406 "href" : "{subdir}",
3407 "rel" : "child"
3408 }
3409 ],
3410 "type" : "array"
3411 }
3412 }
3413 },
3414 "leaf" : 0,
3415 "path" : "/config/whitelist",
3416 "text" : "whitelist"
3417 },
3418 {
3419 "children" : [
3420 {
3421 "children" : [
3422 {
3423 "info" : {
3424 "GET" : {
3425 "description" : "Get LDAP profile configuration.",
3426 "method" : "GET",
3427 "name" : "read_config",
3428 "parameters" : {
3429 "additionalProperties" : 0,
3430 "properties" : {
3431 "profile" : {
3432 "description" : "Profile ID.",
3433 "format" : "pve-configid",
3434 "type" : "string",
3435 "typetext" : "<string>"
3436 }
3437 }
3438 },
3439 "permissions" : {
3440 "check" : [
3441 "admin"
3442 ]
3443 },
3444 "proxyto" : "master",
3445 "returns" : {}
3446 },
3447 "PUT" : {
3448 "description" : "Update LDAP profile settings.",
3449 "method" : "PUT",
3450 "name" : "update_config",
3451 "parameters" : {
3452 "additionalProperties" : 0,
3453 "properties" : {
3454 "accountattr" : {
3455 "default" : "sAMAccountName",
3456 "description" : "Account attribute name name.",
3457 "optional" : 1,
3458 "pattern" : "[a-zA-Z0-9]+",
3459 "type" : "string"
3460 },
3461 "basedn" : {
3462 "description" : "Base domain name.",
3463 "optional" : 1,
3464 "type" : "string",
3465 "typetext" : "<string>"
3466 },
3467 "binddn" : {
3468 "description" : "Bind domain name.",
3469 "optional" : 1,
3470 "type" : "string",
3471 "typetext" : "<string>"
3472 },
3473 "bindpw" : {
3474 "description" : "Bind password.",
3475 "optional" : 1,
3476 "type" : "string",
3477 "typetext" : "<string>"
3478 },
3479 "comment" : {
3480 "description" : "Description.",
3481 "maxLength" : 4096,
3482 "optional" : 1,
3483 "type" : "string",
3484 "typetext" : "<string>"
3485 },
3486 "delete" : {
3487 "description" : "A list of settings you want to delete.",
3488 "format" : "pve-configid-list",
3489 "maxLength" : 4096,
3490 "optional" : 1,
3491 "type" : "string",
3492 "typetext" : "<string>"
3493 },
3494 "digest" : {
3495 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
3496 "maxLength" : 40,
3497 "optional" : 1,
3498 "type" : "string",
3499 "typetext" : "<string>"
3500 },
3501 "disable" : {
3502 "description" : "Flag to disable/deactivate the entry.",
3503 "optional" : 1,
3504 "type" : "boolean",
3505 "typetext" : "<boolean>"
3506 },
3507 "filter" : {
3508 "description" : "LDAP filter.",
3509 "optional" : 1,
3510 "type" : "string",
3511 "typetext" : "<string>"
3512 },
3513 "groupbasedn" : {
3514 "description" : "Base domain name for groups.",
3515 "optional" : 1,
3516 "type" : "string",
3517 "typetext" : "<string>"
3518 },
3519 "mailattr" : {
3520 "default" : "mail, userPrincipalName, proxyAddresses, othermailbox",
3521 "description" : "List of mail attribute names.",
3522 "format" : "string-list",
3523 "optional" : 1,
3524 "pattern" : "[a-zA-Z0-9]+",
3525 "type" : "string"
3526 },
3527 "mode" : {
3528 "default" : "ldap",
3529 "description" : "LDAP protocol mode ('ldap' or 'ldaps').",
3530 "enum" : [
3531 "ldap",
3532 "ldaps"
3533 ],
3534 "optional" : 1,
3535 "type" : "string"
3536 },
3537 "port" : {
3538 "description" : "Specify the port to connect to.",
3539 "maximum" : 65535,
3540 "minimum" : 1,
3541 "optional" : 1,
3542 "type" : "integer",
3543 "typetext" : "<integer> (1 - 65535)"
3544 },
3545 "profile" : {
3546 "description" : "Profile ID.",
3547 "format" : "pve-configid",
3548 "type" : "string",
3549 "typetext" : "<string>"
3550 },
3551 "server1" : {
3552 "description" : "Server address.",
3553 "format" : "address",
3554 "maxLength" : 256,
3555 "optional" : 1,
3556 "type" : "string",
3557 "typetext" : "<string>"
3558 },
3559 "server2" : {
3560 "description" : "Fallback server address. Userd when the first server is not available.",
3561 "format" : "address",
3562 "maxLength" : 256,
3563 "optional" : 1,
3564 "type" : "string",
3565 "typetext" : "<string>"
3566 }
3567 },
3568 "type" : "object"
3569 },
3570 "permissions" : {
3571 "check" : [
3572 "admin"
3573 ]
3574 },
3575 "protected" : 1,
3576 "proxyto" : "master",
3577 "returns" : {
3578 "type" : "null"
3579 }
3580 }
3581 },
3582 "leaf" : 1,
3583 "path" : "/config/ldap/{profile}/config",
3584 "text" : "config"
3585 },
3586 {
3587 "info" : {
3588 "POST" : {
3589 "description" : "Synchronice LDAP users to local database.",
3590 "method" : "POST",
3591 "name" : "sync_profile",
3592 "parameters" : {
3593 "additionalProperties" : 0,
3594 "properties" : {
3595 "profile" : {
3596 "description" : "Profile ID.",
3597 "format" : "pve-configid",
3598 "type" : "string",
3599 "typetext" : "<string>"
3600 }
3601 }
3602 },
3603 "permissions" : {
3604 "check" : [
3605 "admin"
3606 ]
3607 },
3608 "protected" : 1,
3609 "proxyto" : "master",
3610 "returns" : {
3611 "type" : "null"
3612 }
3613 }
3614 },
3615 "leaf" : 1,
3616 "path" : "/config/ldap/{profile}/sync",
3617 "text" : "sync"
3618 },
3619 {
3620 "children" : [
3621 {
3622 "info" : {
3623 "GET" : {
3624 "description" : "Get all email addresses for the specified user.",
3625 "method" : "GET",
3626 "name" : "address_list",
3627 "parameters" : {
3628 "additionalProperties" : 0,
3629 "properties" : {
3630 "email" : {
3631 "description" : "Email address.",
3632 "format" : "email",
3633 "type" : "string",
3634 "typetext" : "<string>"
3635 },
3636 "profile" : {
3637 "description" : "Profile ID.",
3638 "format" : "pve-configid",
3639 "type" : "string",
3640 "typetext" : "<string>"
3641 }
3642 }
3643 },
3644 "permissions" : {
3645 "check" : [
3646 "admin"
3647 ]
3648 },
3649 "protected" : 1,
3650 "proxyto" : "master",
3651 "returns" : {
3652 "items" : {
3653 "properties" : {
3654 "email" : {
3655 "type" : "string"
3656 },
3657 "primary" : {
3658 "type" : "boolean"
3659 }
3660 },
3661 "type" : "object"
3662 },
3663 "type" : "array"
3664 }
3665 }
3666 },
3667 "leaf" : 1,
3668 "path" : "/config/ldap/{profile}/users/{email}",
3669 "text" : "{email}"
3670 }
3671 ],
3672 "info" : {
3673 "GET" : {
3674 "description" : "List LDAP users.",
3675 "method" : "GET",
3676 "name" : "profile_list_users",
3677 "parameters" : {
3678 "additionalProperties" : 0,
3679 "properties" : {
3680 "profile" : {
3681 "description" : "Profile ID.",
3682 "format" : "pve-configid",
3683 "type" : "string",
3684 "typetext" : "<string>"
3685 }
3686 }
3687 },
3688 "permissions" : {
3689 "check" : [
3690 "admin"
3691 ]
3692 },
3693 "protected" : 1,
3694 "proxyto" : "master",
3695 "returns" : {
3696 "items" : {
3697 "properties" : {
3698 "account" : {
3699 "type" : "string"
3700 },
3701 "dn" : {
3702 "type" : "string"
3703 },
3704 "pmail" : {
3705 "type" : "string"
3706 }
3707 },
3708 "type" : "object"
3709 },
3710 "type" : "array"
3711 }
3712 }
3713 },
3714 "leaf" : 0,
3715 "path" : "/config/ldap/{profile}/users",
3716 "text" : "users"
3717 },
3718 {
3719 "info" : {
3720 "GET" : {
3721 "description" : "List LDAP groups.",
3722 "method" : "GET",
3723 "name" : "profile_list_groups",
3724 "parameters" : {
3725 "additionalProperties" : 0,
3726 "properties" : {
3727 "profile" : {
3728 "description" : "Profile ID.",
3729 "format" : "pve-configid",
3730 "type" : "string",
3731 "typetext" : "<string>"
3732 }
3733 }
3734 },
3735 "permissions" : {
3736 "check" : [
3737 "admin"
3738 ]
3739 },
3740 "protected" : 1,
3741 "proxyto" : "master",
3742 "returns" : {
3743 "items" : {
3744 "properties" : {
3745 "dn" : {
3746 "type" : "string"
3747 }
3748 },
3749 "type" : "object"
3750 },
3751 "type" : "array"
3752 }
3753 }
3754 },
3755 "leaf" : 1,
3756 "path" : "/config/ldap/{profile}/groups",
3757 "text" : "groups"
3758 }
3759 ],
3760 "info" : {
3761 "DELETE" : {
3762 "description" : "Delete an LDAP profile",
3763 "method" : "DELETE",
3764 "name" : "delete",
3765 "parameters" : {
3766 "additionalProperties" : 0,
3767 "properties" : {
3768 "profile" : {
3769 "description" : "Profile ID.",
3770 "format" : "pve-configid",
3771 "type" : "string",
3772 "typetext" : "<string>"
3773 }
3774 }
3775 },
3776 "permissions" : {
3777 "check" : [
3778 "admin"
3779 ]
3780 },
3781 "protected" : 1,
3782 "proxyto" : "master",
3783 "returns" : {
3784 "type" : "null"
3785 }
3786 },
3787 "GET" : {
3788 "description" : "Directory index",
3789 "method" : "GET",
3790 "name" : "profile_index",
3791 "parameters" : {
3792 "additionalProperties" : 0,
3793 "properties" : {
3794 "profile" : {
3795 "description" : "Profile ID.",
3796 "format" : "pve-configid",
3797 "type" : "string",
3798 "typetext" : "<string>"
3799 }
3800 }
3801 },
3802 "permissions" : {
3803 "user" : "all"
3804 },
3805 "returns" : {
3806 "items" : {
3807 "properties" : {
3808 "subdir" : {
3809 "type" : "string"
3810 }
3811 },
3812 "type" : "object"
3813 },
3814 "links" : [
3815 {
3816 "href" : "{subdir}",
3817 "rel" : "child"
3818 }
3819 ],
3820 "type" : "array"
3821 }
3822 }
3823 },
3824 "leaf" : 0,
3825 "path" : "/config/ldap/{profile}",
3826 "text" : "{profile}"
3827 }
3828 ],
3829 "info" : {
3830 "GET" : {
3831 "description" : "List configured LDAP profiles.",
3832 "method" : "GET",
3833 "name" : "index",
3834 "parameters" : {
3835 "additionalProperties" : 0
3836 },
3837 "permissions" : {
3838 "check" : [
3839 "admin"
3840 ]
3841 },
3842 "proxyto" : "master",
3843 "returns" : {
3844 "items" : {
3845 "properties" : {
3846 "comment" : {
3847 "optional" : 1,
3848 "type" : "string"
3849 },
3850 "disable" : {
3851 "type" : "boolean"
3852 },
3853 "gcount" : {
3854 "optional" : 1,
3855 "type" : "integer"
3856 },
3857 "mcount" : {
3858 "optional" : 1,
3859 "type" : "integer"
3860 },
3861 "mode" : {
3862 "type" : "string"
3863 },
3864 "profile" : {
3865 "type" : "string"
3866 },
3867 "server1" : {
3868 "type" : "string"
3869 },
3870 "server2" : {
3871 "optional" : 1,
3872 "type" : "string"
3873 },
3874 "ucount" : {
3875 "optional" : 1,
3876 "type" : "integer"
3877 }
3878 },
3879 "type" : "object"
3880 },
3881 "links" : [
3882 {
3883 "href" : "{profile}",
3884 "rel" : "child"
3885 }
3886 ],
3887 "type" : "array"
3888 }
3889 },
3890 "POST" : {
3891 "description" : "Add LDAP profile.",
3892 "method" : "POST",
3893 "name" : "create",
3894 "parameters" : {
3895 "additionalProperties" : 0,
3896 "properties" : {
3897 "accountattr" : {
3898 "default" : "sAMAccountName",
3899 "description" : "Account attribute name name.",
3900 "optional" : 1,
3901 "pattern" : "[a-zA-Z0-9]+",
3902 "type" : "string"
3903 },
3904 "basedn" : {
3905 "description" : "Base domain name.",
3906 "optional" : 1,
3907 "type" : "string",
3908 "typetext" : "<string>"
3909 },
3910 "binddn" : {
3911 "description" : "Bind domain name.",
3912 "optional" : 1,
3913 "type" : "string",
3914 "typetext" : "<string>"
3915 },
3916 "bindpw" : {
3917 "description" : "Bind password.",
3918 "optional" : 1,
3919 "type" : "string",
3920 "typetext" : "<string>"
3921 },
3922 "comment" : {
3923 "description" : "Description.",
3924 "maxLength" : 4096,
3925 "optional" : 1,
3926 "type" : "string",
3927 "typetext" : "<string>"
3928 },
3929 "disable" : {
3930 "description" : "Flag to disable/deactivate the entry.",
3931 "optional" : 1,
3932 "type" : "boolean",
3933 "typetext" : "<boolean>"
3934 },
3935 "filter" : {
3936 "description" : "LDAP filter.",
3937 "optional" : 1,
3938 "type" : "string",
3939 "typetext" : "<string>"
3940 },
3941 "groupbasedn" : {
3942 "description" : "Base domain name for groups.",
3943 "optional" : 1,
3944 "type" : "string",
3945 "typetext" : "<string>"
3946 },
3947 "mailattr" : {
3948 "default" : "mail, userPrincipalName, proxyAddresses, othermailbox",
3949 "description" : "List of mail attribute names.",
3950 "format" : "string-list",
3951 "optional" : 1,
3952 "pattern" : "[a-zA-Z0-9]+",
3953 "type" : "string"
3954 },
3955 "mode" : {
3956 "default" : "ldap",
3957 "description" : "LDAP protocol mode ('ldap' or 'ldaps').",
3958 "enum" : [
3959 "ldap",
3960 "ldaps"
3961 ],
3962 "optional" : 1,
3963 "type" : "string"
3964 },
3965 "port" : {
3966 "description" : "Specify the port to connect to.",
3967 "maximum" : 65535,
3968 "minimum" : 1,
3969 "optional" : 1,
3970 "type" : "integer",
3971 "typetext" : "<integer> (1 - 65535)"
3972 },
3973 "profile" : {
3974 "description" : "Profile ID.",
3975 "format" : "pve-configid",
3976 "type" : "string",
3977 "typetext" : "<string>"
3978 },
3979 "server1" : {
3980 "description" : "Server address.",
3981 "format" : "address",
3982 "maxLength" : 256,
3983 "optional" : 0,
3984 "type" : "string",
3985 "typetext" : "<string>"
3986 },
3987 "server2" : {
3988 "description" : "Fallback server address. Userd when the first server is not available.",
3989 "format" : "address",
3990 "maxLength" : 256,
3991 "optional" : 1,
3992 "type" : "string",
3993 "typetext" : "<string>"
3994 }
3995 },
3996 "type" : "object"
3997 },
3998 "permissions" : {
3999 "check" : [
4000 "admin"
4001 ]
4002 },
4003 "protected" : 1,
4004 "proxyto" : "master",
4005 "returns" : {
4006 "type" : "null"
4007 }
4008 }
4009 },
4010 "leaf" : 0,
4011 "path" : "/config/ldap",
4012 "text" : "ldap"
4013 },
4014 {
4015 "children" : [
4016 {
4017 "info" : {
4018 "DELETE" : {
4019 "description" : "Delete a relay domain",
4020 "method" : "DELETE",
4021 "name" : "delete",
4022 "parameters" : {
4023 "additionalProperties" : 0,
4024 "properties" : {
4025 "domain" : {
4026 "description" : "Domain name.",
4027 "format" : "dns-name",
4028 "type" : "string",
4029 "typetext" : "<string>"
4030 }
4031 }
4032 },
4033 "protected" : 1,
4034 "proxyto" : "master",
4035 "returns" : {
4036 "type" : "null"
4037 }
4038 },
4039 "GET" : {
4040 "description" : "Read Domain data (comment).",
4041 "method" : "GET",
4042 "name" : "read",
4043 "parameters" : {
4044 "additionalProperties" : 0,
4045 "properties" : {
4046 "domain" : {
4047 "description" : "Domain name.",
4048 "format" : "dns-name",
4049 "type" : "string",
4050 "typetext" : "<string>"
4051 }
4052 }
4053 },
4054 "proxyto" : "master",
4055 "returns" : {
4056 "properties" : {
4057 "comment" : {
4058 "type" : "string"
4059 },
4060 "domain" : {
4061 "type" : "string"
4062 }
4063 },
4064 "type" : "object"
4065 }
4066 },
4067 "PUT" : {
4068 "description" : "Update relay domain data (comment).",
4069 "method" : "PUT",
4070 "name" : "write",
4071 "parameters" : {
4072 "additionalProperties" : 0,
4073 "properties" : {
4074 "comment" : {
4075 "description" : "Comment.",
4076 "type" : "string",
4077 "typetext" : "<string>"
4078 },
4079 "domain" : {
4080 "description" : "Domain name.",
4081 "format" : "dns-name",
4082 "type" : "string",
4083 "typetext" : "<string>"
4084 }
4085 }
4086 },
4087 "protected" : 1,
4088 "proxyto" : "master",
4089 "returns" : {
4090 "type" : "null"
4091 }
4092 }
4093 },
4094 "leaf" : 1,
4095 "path" : "/config/domains/{domain}",
4096 "text" : "{domain}"
4097 }
4098 ],
4099 "info" : {
4100 "GET" : {
4101 "description" : "List relay domains.",
4102 "method" : "GET",
4103 "name" : "index",
4104 "parameters" : {
4105 "additionalProperties" : 0
4106 },
4107 "proxyto" : "master",
4108 "returns" : {
4109 "items" : {
4110 "properties" : {
4111 "comment" : {
4112 "type" : "string"
4113 },
4114 "domain" : {
4115 "type" : "string"
4116 }
4117 },
4118 "type" : "object"
4119 },
4120 "links" : [
4121 {
4122 "href" : "{domain}",
4123 "rel" : "child"
4124 }
4125 ],
4126 "type" : "array"
4127 }
4128 },
4129 "POST" : {
4130 "description" : "Add relay domain.",
4131 "method" : "POST",
4132 "name" : "create",
4133 "parameters" : {
4134 "additionalProperties" : 0,
4135 "properties" : {
4136 "comment" : {
4137 "description" : "Comment.",
4138 "optional" : 1,
4139 "type" : "string",
4140 "typetext" : "<string>"
4141 },
4142 "domain" : {
4143 "description" : "Domain name.",
4144 "format" : "dns-name",
4145 "type" : "string",
4146 "typetext" : "<string>"
4147 }
4148 }
4149 },
4150 "protected" : 1,
4151 "proxyto" : "master",
4152 "returns" : {
4153 "type" : "null"
4154 }
4155 }
4156 },
4157 "leaf" : 0,
4158 "path" : "/config/domains",
4159 "text" : "domains"
4160 },
4161 {
4162 "children" : [
4163 {
4164 "info" : {
4165 "DELETE" : {
4166 "description" : "Delete a transport map entry",
4167 "method" : "DELETE",
4168 "name" : "delete",
4169 "parameters" : {
4170 "additionalProperties" : 0,
4171 "properties" : {
4172 "domain" : {
4173 "description" : "Domain name.",
4174 "format" : "transport-domain",
4175 "type" : "string",
4176 "typetext" : "<string>"
4177 }
4178 }
4179 },
4180 "protected" : 1,
4181 "proxyto" : "master",
4182 "returns" : {
4183 "type" : "null"
4184 }
4185 },
4186 "GET" : {
4187 "description" : "Read transport map entry.",
4188 "method" : "GET",
4189 "name" : "read",
4190 "parameters" : {
4191 "additionalProperties" : 0,
4192 "properties" : {
4193 "domain" : {
4194 "description" : "Domain name.",
4195 "format" : "transport-domain",
4196 "type" : "string",
4197 "typetext" : "<string>"
4198 }
4199 }
4200 },
4201 "proxyto" : "master",
4202 "returns" : {
4203 "properties" : {
4204 "comment" : {
4205 "type" : "string"
4206 },
4207 "domain" : {
4208 "type" : "string"
4209 },
4210 "host" : {
4211 "type" : "string"
4212 },
4213 "port" : {
4214 "type" : "integer"
4215 },
4216 "use_mx" : {
4217 "type" : "boolean"
4218 }
4219 },
4220 "type" : "object"
4221 }
4222 },
4223 "PUT" : {
4224 "description" : "Update transport map entry.",
4225 "method" : "PUT",
4226 "name" : "write",
4227 "parameters" : {
4228 "additionalProperties" : 0,
4229 "properties" : {
4230 "comment" : {
4231 "description" : "Comment.",
4232 "optional" : 1,
4233 "type" : "string",
4234 "typetext" : "<string>"
4235 },
4236 "domain" : {
4237 "description" : "Domain name.",
4238 "format" : "transport-domain",
4239 "type" : "string",
4240 "typetext" : "<string>"
4241 },
4242 "host" : {
4243 "description" : "Target host (name or IP address).",
4244 "format" : "address",
4245 "optional" : 1,
4246 "type" : "string",
4247 "typetext" : "<string>"
4248 },
4249 "port" : {
4250 "description" : "SMTP port.",
4251 "maximum" : 65535,
4252 "minimum" : 1,
4253 "optional" : 1,
4254 "type" : "integer",
4255 "typetext" : "<integer> (1 - 65535)"
4256 },
4257 "use_mx" : {
4258 "description" : "Enable MX lookups.",
4259 "optional" : 1,
4260 "type" : "boolean",
4261 "typetext" : "<boolean>"
4262 }
4263 }
4264 },
4265 "protected" : 1,
4266 "proxyto" : "master",
4267 "returns" : {
4268 "type" : "null"
4269 }
4270 }
4271 },
4272 "leaf" : 1,
4273 "path" : "/config/transport/{domain}",
4274 "text" : "{domain}"
4275 }
4276 ],
4277 "info" : {
4278 "GET" : {
4279 "description" : "List transport map entries.",
4280 "method" : "GET",
4281 "name" : "index",
4282 "parameters" : {
4283 "additionalProperties" : 0
4284 },
4285 "proxyto" : "master",
4286 "returns" : {
4287 "items" : {
4288 "properties" : {
4289 "comment" : {
4290 "type" : "string"
4291 },
4292 "domain" : {
4293 "type" : "string"
4294 },
4295 "host" : {
4296 "type" : "string"
4297 },
4298 "port" : {
4299 "type" : "integer"
4300 },
4301 "use_mx" : {
4302 "type" : "boolean"
4303 }
4304 },
4305 "type" : "object"
4306 },
4307 "links" : [
4308 {
4309 "href" : "{id}",
4310 "rel" : "child"
4311 }
4312 ],
4313 "type" : "array"
4314 }
4315 },
4316 "POST" : {
4317 "description" : "Add transport map entry.",
4318 "method" : "POST",
4319 "name" : "create",
4320 "parameters" : {
4321 "additionalProperties" : 0,
4322 "properties" : {
4323 "comment" : {
4324 "description" : "Comment.",
4325 "optional" : 1,
4326 "type" : "string",
4327 "typetext" : "<string>"
4328 },
4329 "domain" : {
4330 "description" : "Domain name.",
4331 "format" : "transport-domain",
4332 "type" : "string",
4333 "typetext" : "<string>"
4334 },
4335 "host" : {
4336 "description" : "Target host (name or IP address).",
4337 "format" : "address",
4338 "type" : "string",
4339 "typetext" : "<string>"
4340 },
4341 "port" : {
4342 "default" : 25,
4343 "description" : "SMTP port.",
4344 "maximum" : 65535,
4345 "minimum" : 1,
4346 "optional" : 1,
4347 "type" : "integer",
4348 "typetext" : "<integer> (1 - 65535)"
4349 },
4350 "use_mx" : {
4351 "default" : 1,
4352 "description" : "Enable MX lookups.",
4353 "optional" : 1,
4354 "type" : "boolean",
4355 "typetext" : "<boolean>"
4356 }
4357 }
4358 },
4359 "protected" : 1,
4360 "proxyto" : "master",
4361 "returns" : {
4362 "type" : "null"
4363 }
4364 }
4365 },
4366 "leaf" : 0,
4367 "path" : "/config/transport",
4368 "text" : "transport"
4369 },
4370 {
4371 "children" : [
4372 {
4373 "info" : {
4374 "DELETE" : {
4375 "description" : "Delete a truster network",
4376 "method" : "DELETE",
4377 "name" : "delete",
4378 "parameters" : {
4379 "additionalProperties" : 0,
4380 "properties" : {
4381 "cidr" : {
4382 "description" : "IPv4 or IPv6 network in CIDR notation.",
4383 "format" : "CIDR",
4384 "type" : "string",
4385 "typetext" : "<string>"
4386 }
4387 }
4388 },
4389 "protected" : 1,
4390 "proxyto" : "master",
4391 "returns" : {
4392 "type" : "null"
4393 }
4394 },
4395 "GET" : {
4396 "description" : "Read trusted network data (comment).",
4397 "method" : "GET",
4398 "name" : "read",
4399 "parameters" : {
4400 "additionalProperties" : 0,
4401 "properties" : {
4402 "cidr" : {
4403 "description" : "IPv4 or IPv6 network in CIDR notation.",
4404 "format" : "CIDR",
4405 "type" : "string",
4406 "typetext" : "<string>"
4407 }
4408 }
4409 },
4410 "proxyto" : "master",
4411 "returns" : {
4412 "properties" : {
4413 "cidr" : {
4414 "type" : "string"
4415 },
4416 "comment" : {
4417 "type" : "string"
4418 }
4419 },
4420 "type" : "object"
4421 }
4422 },
4423 "PUT" : {
4424 "description" : "Update trusted data (comment).",
4425 "method" : "PUT",
4426 "name" : "write",
4427 "parameters" : {
4428 "additionalProperties" : 0,
4429 "properties" : {
4430 "cidr" : {
4431 "description" : "IPv4 or IPv6 network in CIDR notation.",
4432 "type" : "string",
4433 "typetext" : "<string>"
4434 },
4435 "comment" : {
4436 "description" : "Comment.",
4437 "type" : "string",
4438 "typetext" : "<string>"
4439 }
4440 }
4441 },
4442 "protected" : 1,
4443 "proxyto" : "master",
4444 "returns" : {
4445 "type" : "null"
4446 }
4447 }
4448 },
4449 "leaf" : 1,
4450 "path" : "/config/mynetworks/{cidr}",
4451 "text" : "{cidr}"
4452 }
4453 ],
4454 "info" : {
4455 "GET" : {
4456 "description" : "List of trusted networks from where SMTP clients are allowed to relay mail through Proxmox Mail Gateway.",
4457 "method" : "GET",
4458 "name" : "index",
4459 "parameters" : {
4460 "additionalProperties" : 0
4461 },
4462 "proxyto" : "master",
4463 "returns" : {
4464 "items" : {
4465 "properties" : {
4466 "cidr" : {
4467 "type" : "string"
4468 }
4469 },
4470 "type" : "object"
4471 },
4472 "links" : [
4473 {
4474 "href" : "{cide}",
4475 "rel" : "child"
4476 }
4477 ],
4478 "type" : "array"
4479 }
4480 },
4481 "POST" : {
4482 "description" : "Add a trusted network.",
4483 "method" : "POST",
4484 "name" : "create",
4485 "parameters" : {
4486 "additionalProperties" : 0,
4487 "properties" : {
4488 "cidr" : {
4489 "description" : "IPv4 or IPv6 network in CIDR notation.",
4490 "format" : "CIDR",
4491 "type" : "string",
4492 "typetext" : "<string>"
4493 },
4494 "comment" : {
4495 "description" : "Comment.",
4496 "optional" : 1,
4497 "type" : "string",
4498 "typetext" : "<string>"
4499 }
4500 }
4501 },
4502 "protected" : 1,
4503 "proxyto" : "master",
4504 "returns" : {
4505 "type" : "null"
4506 }
4507 }
4508 },
4509 "leaf" : 0,
4510 "path" : "/config/mynetworks",
4511 "text" : "mynetworks"
4512 },
4513 {
4514 "info" : {
4515 "GET" : {
4516 "description" : "Cluster node index.",
4517 "method" : "GET",
4518 "name" : "index",
4519 "parameters" : {
4520 "additionalProperties" : 0
4521 },
4522 "returns" : {
4523 "items" : {
4524 "properties" : {
4525 "cid" : {
4526 "type" : "integer"
4527 }
4528 },
4529 "type" : "object"
4530 },
4531 "links" : [
4532 {
4533 "href" : "{cid}",
4534 "rel" : "child"
4535 }
4536 ],
4537 "type" : "array"
4538 }
4539 }
4540 },
4541 "leaf" : 1,
4542 "path" : "/config/cluster",
4543 "text" : "cluster"
4544 },
4545 {
4546 "info" : {
4547 "GET" : {
4548 "description" : "Read admin configuration properties.",
4549 "method" : "GET",
4550 "name" : "read_admin_section",
4551 "parameters" : {
4552 "additionalProperties" : 0
4553 },
4554 "proxyto" : "master",
4555 "returns" : {
4556 "type" : "object"
4557 }
4558 },
4559 "PUT" : {
4560 "description" : "Update admin configuration properties.",
4561 "method" : "PUT",
4562 "name" : "update_admin_section",
4563 "parameters" : {
4564 "additionalProperties" : 0,
4565 "properties" : {
4566 "dailyreport" : {
4567 "default" : 1,
4568 "description" : "Send daily reports.",
4569 "optional" : 1,
4570 "type" : "boolean",
4571 "typetext" : "<boolean>"
4572 },
4573 "delete" : {
4574 "description" : "A list of settings you want to delete.",
4575 "format" : "pve-configid-list",
4576 "maxLength" : 4096,
4577 "optional" : 1,
4578 "type" : "string",
4579 "typetext" : "<string>"
4580 },
4581 "demo" : {
4582 "default" : 0,
4583 "description" : "Demo mode - do not start SMTP filter.",
4584 "optional" : 1,
4585 "type" : "boolean",
4586 "typetext" : "<boolean>"
4587 },
4588 "digest" : {
4589 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
4590 "maxLength" : 40,
4591 "optional" : 1,
4592 "type" : "string",
4593 "typetext" : "<string>"
4594 },
4595 "email" : {
4596 "default" : "admin@domain.tld",
4597 "description" : "Administrator E-Mail address.",
4598 "format" : "email",
4599 "optional" : 1,
4600 "type" : "string",
4601 "typetext" : "<string>"
4602 },
4603 "proxypassword" : {
4604 "description" : "HTTP proxy password.",
4605 "optional" : 1,
4606 "type" : "string",
4607 "typetext" : "<string>"
4608 },
4609 "proxyport" : {
4610 "default" : 8080,
4611 "description" : "HTTP proxy port.",
4612 "minimum" : 1,
4613 "optional" : 1,
4614 "type" : "integer",
4615 "typetext" : "<integer> (1 - N)"
4616 },
4617 "proxyserver" : {
4618 "description" : "HTTP proxy server address.",
4619 "optional" : 1,
4620 "type" : "string",
4621 "typetext" : "<string>"
4622 },
4623 "proxyuser" : {
4624 "description" : "HTTP proxy user name.",
4625 "optional" : 1,
4626 "type" : "string",
4627 "typetext" : "<string>"
4628 },
4629 "statlifetime" : {
4630 "default" : 7,
4631 "description" : "User Statistics Lifetime (days)",
4632 "minimum" : 1,
4633 "optional" : 1,
4634 "type" : "integer",
4635 "typetext" : "<integer> (1 - N)"
4636 }
4637 },
4638 "type" : "object"
4639 },
4640 "protected" : 1,
4641 "proxyto" : "master",
4642 "returns" : {
4643 "type" : "null"
4644 }
4645 }
4646 },
4647 "leaf" : 1,
4648 "path" : "/config/admin",
4649 "text" : "admin"
4650 },
4651 {
4652 "info" : {
4653 "GET" : {
4654 "description" : "Read clamav configuration properties.",
4655 "method" : "GET",
4656 "name" : "read_clamav_section",
4657 "parameters" : {
4658 "additionalProperties" : 0
4659 },
4660 "proxyto" : "master",
4661 "returns" : {
4662 "type" : "object"
4663 }
4664 },
4665 "PUT" : {
4666 "description" : "Update clamav configuration properties.",
4667 "method" : "PUT",
4668 "name" : "update_clamav_section",
4669 "parameters" : {
4670 "additionalProperties" : 0,
4671 "properties" : {
4672 "archiveblockencrypted" : {
4673 "default" : 0,
4674 "description" : "Wether to block encrypted archives. Mark encrypted archives as viruses.",
4675 "optional" : 1,
4676 "type" : "boolean",
4677 "typetext" : "<boolean>"
4678 },
4679 "archivemaxfiles" : {
4680 "default" : 1000,
4681 "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.",
4682 "minimum" : 0,
4683 "optional" : 1,
4684 "type" : "integer",
4685 "typetext" : "<integer> (0 - N)"
4686 },
4687 "archivemaxrec" : {
4688 "default" : 5,
4689 "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.",
4690 "minimum" : 1,
4691 "optional" : 1,
4692 "type" : "integer",
4693 "typetext" : "<integer> (1 - N)"
4694 },
4695 "archivemaxsize" : {
4696 "default" : 25000000,
4697 "description" : "Files larger than this limit won't be scanned.",
4698 "minimum" : 1000000,
4699 "optional" : 1,
4700 "type" : "integer",
4701 "typetext" : "<integer> (1000000 - N)"
4702 },
4703 "dbmirror" : {
4704 "default" : "database.clamav.net",
4705 "description" : "ClamAV database mirror server.",
4706 "optional" : 1,
4707 "type" : "string",
4708 "typetext" : "<string>"
4709 },
4710 "delete" : {
4711 "description" : "A list of settings you want to delete.",
4712 "format" : "pve-configid-list",
4713 "maxLength" : 4096,
4714 "optional" : 1,
4715 "type" : "string",
4716 "typetext" : "<string>"
4717 },
4718 "digest" : {
4719 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
4720 "maxLength" : 40,
4721 "optional" : 1,
4722 "type" : "string",
4723 "typetext" : "<string>"
4724 },
4725 "maxcccount" : {
4726 "default" : 0,
4727 "description" : "This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.",
4728 "minimum" : 0,
4729 "optional" : 1,
4730 "type" : "integer",
4731 "typetext" : "<integer> (0 - N)"
4732 },
4733 "maxscansize" : {
4734 "default" : 100000000,
4735 "description" : "Sets the maximum amount of data to be scanned for each input file.",
4736 "minimum" : 1000000,
4737 "optional" : 1,
4738 "type" : "integer",
4739 "typetext" : "<integer> (1000000 - N)"
4740 },
4741 "safebrowsing" : {
4742 "default" : 1,
4743 "description" : "Enables support for Google Safe Browsing.",
4744 "optional" : 1,
4745 "type" : "boolean",
4746 "typetext" : "<boolean>"
4747 }
4748 },
4749 "type" : "object"
4750 },
4751 "protected" : 1,
4752 "proxyto" : "master",
4753 "returns" : {
4754 "type" : "null"
4755 }
4756 }
4757 },
4758 "leaf" : 1,
4759 "path" : "/config/clamav",
4760 "text" : "clamav"
4761 },
4762 {
4763 "info" : {
4764 "GET" : {
4765 "description" : "Read mail configuration properties.",
4766 "method" : "GET",
4767 "name" : "read_mail_section",
4768 "parameters" : {
4769 "additionalProperties" : 0
4770 },
4771 "proxyto" : "master",
4772 "returns" : {
4773 "type" : "object"
4774 }
4775 },
4776 "PUT" : {
4777 "description" : "Update mail configuration properties.",
4778 "method" : "PUT",
4779 "name" : "update_mail_section",
4780 "parameters" : {
4781 "additionalProperties" : 0,
4782 "properties" : {
4783 "banner" : {
4784 "default" : "ESMTP Proxmox",
4785 "description" : "ESMTP banner.",
4786 "maxLength" : 1024,
4787 "optional" : 1,
4788 "type" : "string",
4789 "typetext" : "<string>"
4790 },
4791 "conn_count_limit" : {
4792 "default" : 50,
4793 "description" : "How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.",
4794 "minimum" : 0,
4795 "optional" : 1,
4796 "type" : "integer",
4797 "typetext" : "<integer> (0 - N)"
4798 },
4799 "conn_rate_limit" : {
4800 "default" : 0,
4801 "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.",
4802 "minimum" : 0,
4803 "optional" : 1,
4804 "type" : "integer",
4805 "typetext" : "<integer> (0 - N)"
4806 },
4807 "delete" : {
4808 "description" : "A list of settings you want to delete.",
4809 "format" : "pve-configid-list",
4810 "maxLength" : 4096,
4811 "optional" : 1,
4812 "type" : "string",
4813 "typetext" : "<string>"
4814 },
4815 "digest" : {
4816 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
4817 "maxLength" : 40,
4818 "optional" : 1,
4819 "type" : "string",
4820 "typetext" : "<string>"
4821 },
4822 "dnsbl_sites" : {
4823 "description" : "Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).",
4824 "optional" : 1,
4825 "type" : "string",
4826 "typetext" : "<string>"
4827 },
4828 "dwarning" : {
4829 "default" : 4,
4830 "description" : "SMTP delay warning time (in hours).",
4831 "minimum" : 0,
4832 "optional" : 1,
4833 "type" : "integer",
4834 "typetext" : "<integer> (0 - N)"
4835 },
4836 "ext_port" : {
4837 "default" : 26,
4838 "description" : "SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.",
4839 "maximum" : 65535,
4840 "minimum" : 1,
4841 "optional" : 1,
4842 "type" : "integer",
4843 "typetext" : "<integer> (1 - 65535)"
4844 },
4845 "greylist" : {
4846 "default" : 1,
4847 "description" : "Use Greylisting.",
4848 "optional" : 1,
4849 "type" : "boolean",
4850 "typetext" : "<boolean>"
4851 },
4852 "helotests" : {
4853 "default" : 0,
4854 "description" : "Use SMTP HELO tests.",
4855 "optional" : 1,
4856 "type" : "boolean",
4857 "typetext" : "<boolean>"
4858 },
4859 "hide_received" : {
4860 "default" : 0,
4861 "description" : "Hide received header in outgoing mails.",
4862 "optional" : 1,
4863 "type" : "boolean",
4864 "typetext" : "<boolean>"
4865 },
4866 "int_port" : {
4867 "default" : 25,
4868 "description" : "SMTP port number for outgoing mail (trusted).",
4869 "maximum" : 65535,
4870 "minimum" : 1,
4871 "optional" : 1,
4872 "type" : "integer",
4873 "typetext" : "<integer> (1 - 65535)"
4874 },
4875 "max_filters" : {
4876 "default" : 15,
4877 "description" : "Maximum number of pmg-smtp-filter processes.",
4878 "maximum" : 40,
4879 "minimum" : 3,
4880 "optional" : 1,
4881 "type" : "integer",
4882 "typetext" : "<integer> (3 - 40)"
4883 },
4884 "max_policy" : {
4885 "default" : 5,
4886 "description" : "Maximum number of pmgpolicy processes.",
4887 "maximum" : 10,
4888 "minimum" : 2,
4889 "optional" : 1,
4890 "type" : "integer",
4891 "typetext" : "<integer> (2 - 10)"
4892 },
4893 "max_smtpd_in" : {
4894 "default" : 99,
4895 "description" : "Maximum number of SMTP daemon processes (in).",
4896 "maximum" : 100,
4897 "minimum" : 3,
4898 "optional" : 1,
4899 "type" : "integer",
4900 "typetext" : "<integer> (3 - 100)"
4901 },
4902 "max_smtpd_out" : {
4903 "default" : 99,
4904 "description" : "Maximum number of SMTP daemon processes (out).",
4905 "maximum" : 100,
4906 "minimum" : 3,
4907 "optional" : 1,
4908 "type" : "integer",
4909 "typetext" : "<integer> (3 - 100)"
4910 },
4911 "maxsize" : {
4912 "default" : 10485760,
4913 "description" : "Maximum email size. Larger mails are rejected.",
4914 "minimum" : 1024,
4915 "optional" : 1,
4916 "type" : "integer",
4917 "typetext" : "<integer> (1024 - N)"
4918 },
4919 "message_rate_limit" : {
4920 "default" : 0,
4921 "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.",
4922 "minimum" : 0,
4923 "optional" : 1,
4924 "type" : "integer",
4925 "typetext" : "<integer> (0 - N)"
4926 },
4927 "rejectunknown" : {
4928 "default" : 0,
4929 "description" : "Reject unknown clients.",
4930 "optional" : 1,
4931 "type" : "boolean",
4932 "typetext" : "<boolean>"
4933 },
4934 "rejectunknownsender" : {
4935 "default" : 0,
4936 "description" : "Reject unknown senders.",
4937 "optional" : 1,
4938 "type" : "boolean",
4939 "typetext" : "<boolean>"
4940 },
4941 "relay" : {
4942 "description" : "The default mail delivery transport (incoming mails).",
4943 "format" : "address",
4944 "optional" : 1,
4945 "type" : "string",
4946 "typetext" : "<string>"
4947 },
4948 "relaynomx" : {
4949 "default" : 0,
4950 "description" : "Disable MX lookups for default relay.",
4951 "optional" : 1,
4952 "type" : "boolean",
4953 "typetext" : "<boolean>"
4954 },
4955 "relayport" : {
4956 "default" : 25,
4957 "description" : "SMTP port number for relay host.",
4958 "maximum" : 65535,
4959 "minimum" : 1,
4960 "optional" : 1,
4961 "type" : "integer",
4962 "typetext" : "<integer> (1 - 65535)"
4963 },
4964 "smarthost" : {
4965 "description" : "When set, all outgoing mails are deliverd to the specified smarthost.",
4966 "format" : "address",
4967 "optional" : 1,
4968 "type" : "string",
4969 "typetext" : "<string>"
4970 },
4971 "spf" : {
4972 "default" : 1,
4973 "description" : "Use Sender Policy Framework.",
4974 "optional" : 1,
4975 "type" : "boolean",
4976 "typetext" : "<boolean>"
4977 },
4978 "tls" : {
4979 "default" : 0,
4980 "description" : "Enable TLS.",
4981 "optional" : 1,
4982 "type" : "boolean",
4983 "typetext" : "<boolean>"
4984 },
4985 "tlsheader" : {
4986 "default" : 0,
4987 "description" : "Add TLS received header.",
4988 "optional" : 1,
4989 "type" : "boolean",
4990 "typetext" : "<boolean>"
4991 },
4992 "tlslog" : {
4993 "default" : 0,
4994 "description" : "Enable TLS Logging.",
4995 "optional" : 1,
4996 "type" : "boolean",
4997 "typetext" : "<boolean>"
4998 },
4999 "use_rbl" : {
5000 "default" : 1,
5001 "description" : "Use Realtime Blacklists.",
5002 "optional" : 1,
5003 "type" : "boolean",
5004 "typetext" : "<boolean>"
5005 },
5006 "verifyreceivers" : {
5007 "description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.",
5008 "enum" : [
5009 "450",
5010 "550"
5011 ],
5012 "optional" : 1,
5013 "type" : "string"
5014 }
5015 },
5016 "type" : "object"
5017 },
5018 "protected" : 1,
5019 "proxyto" : "master",
5020 "returns" : {
5021 "type" : "null"
5022 }
5023 }
5024 },
5025 "leaf" : 1,
5026 "path" : "/config/mail",
5027 "text" : "mail"
5028 },
5029 {
5030 "info" : {
5031 "GET" : {
5032 "description" : "Read spam configuration properties.",
5033 "method" : "GET",
5034 "name" : "read_spam_section",
5035 "parameters" : {
5036 "additionalProperties" : 0
5037 },
5038 "proxyto" : "master",
5039 "returns" : {
5040 "type" : "object"
5041 }
5042 },
5043 "PUT" : {
5044 "description" : "Update spam configuration properties.",
5045 "method" : "PUT",
5046 "name" : "update_spam_section",
5047 "parameters" : {
5048 "additionalProperties" : 0,
5049 "properties" : {
5050 "bounce_score" : {
5051 "default" : 0,
5052 "description" : "Additional score for bounce mails.",
5053 "maximum" : 1000,
5054 "minimum" : 0,
5055 "optional" : 1,
5056 "type" : "integer",
5057 "typetext" : "<integer> (0 - 1000)"
5058 },
5059 "delete" : {
5060 "description" : "A list of settings you want to delete.",
5061 "format" : "pve-configid-list",
5062 "maxLength" : 4096,
5063 "optional" : 1,
5064 "type" : "string",
5065 "typetext" : "<string>"
5066 },
5067 "digest" : {
5068 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
5069 "maxLength" : 40,
5070 "optional" : 1,
5071 "type" : "string",
5072 "typetext" : "<string>"
5073 },
5074 "languages" : {
5075 "default" : "all",
5076 "description" : "This option is used to specify which languages are considered OK for incoming mail.",
5077 "optional" : 1,
5078 "pattern" : "(all|([a-z][a-z])+( ([a-z][a-z])+)*)",
5079 "type" : "string"
5080 },
5081 "maxspamsize" : {
5082 "default" : 204800,
5083 "description" : "Maximum size of spam messages in bytes.",
5084 "minimum" : 64,
5085 "optional" : 1,
5086 "type" : "integer",
5087 "typetext" : "<integer> (64 - N)"
5088 },
5089 "rbl_checks" : {
5090 "default" : 1,
5091 "description" : "Enable real time blacklists (RBL) checks.",
5092 "optional" : 1,
5093 "type" : "boolean",
5094 "typetext" : "<boolean>"
5095 },
5096 "use_awl" : {
5097 "default" : 1,
5098 "description" : "Use the Auto-Whitelist plugin.",
5099 "optional" : 1,
5100 "type" : "boolean",
5101 "typetext" : "<boolean>"
5102 },
5103 "use_bayes" : {
5104 "default" : 1,
5105 "description" : "Whether to use the naive-Bayesian-style classifier.",
5106 "optional" : 1,
5107 "type" : "boolean",
5108 "typetext" : "<boolean>"
5109 },
5110 "use_razor" : {
5111 "default" : 1,
5112 "description" : "Whether to use Razor2, if it is available.",
5113 "optional" : 1,
5114 "type" : "boolean",
5115 "typetext" : "<boolean>"
5116 },
5117 "wl_bounce_relays" : {
5118 "description" : "Whitelist legitimate bounce relays.",
5119 "optional" : 1,
5120 "type" : "string",
5121 "typetext" : "<string>"
5122 }
5123 },
5124 "type" : "object"
5125 },
5126 "protected" : 1,
5127 "proxyto" : "master",
5128 "returns" : {
5129 "type" : "null"
5130 }
5131 }
5132 },
5133 "leaf" : 1,
5134 "path" : "/config/spam",
5135 "text" : "spam"
5136 },
5137 {
5138 "info" : {
5139 "GET" : {
5140 "description" : "Read spamquar configuration properties.",
5141 "method" : "GET",
5142 "name" : "read_spamquar_section",
5143 "parameters" : {
5144 "additionalProperties" : 0
5145 },
5146 "proxyto" : "master",
5147 "returns" : {
5148 "type" : "object"
5149 }
5150 },
5151 "PUT" : {
5152 "description" : "Update spamquar configuration properties.",
5153 "method" : "PUT",
5154 "name" : "update_spamquar_section",
5155 "parameters" : {
5156 "additionalProperties" : 0,
5157 "properties" : {
5158 "allowhrefs" : {
5159 "default" : 1,
5160 "description" : "Allow to view hyperlinks.",
5161 "optional" : 1,
5162 "type" : "boolean",
5163 "typetext" : "<boolean>"
5164 },
5165 "authmode" : {
5166 "default" : "ticket",
5167 "description" : "Authentication mode to access the quarantine interface. Mode 'ticket' allows login using tickets sent with the daily spam report. Mode 'ldap' requires to login using an LDAP account. Finally, mode 'ldapticket' allows both ways.",
5168 "enum" : [
5169 "ticket",
5170 "ldap",
5171 "ldapticket"
5172 ],
5173 "optional" : 1,
5174 "type" : "string"
5175 },
5176 "delete" : {
5177 "description" : "A list of settings you want to delete.",
5178 "format" : "pve-configid-list",
5179 "maxLength" : 4096,
5180 "optional" : 1,
5181 "type" : "string",
5182 "typetext" : "<string>"
5183 },
5184 "digest" : {
5185 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
5186 "maxLength" : 40,
5187 "optional" : 1,
5188 "type" : "string",
5189 "typetext" : "<string>"
5190 },
5191 "hostname" : {
5192 "description" : "Quarantine Host. Usefule if you run a Cluster and want users to connect to a specific host.",
5193 "format" : "address",
5194 "optional" : 1,
5195 "type" : "string",
5196 "typetext" : "<string>"
5197 },
5198 "lifetime" : {
5199 "default" : 7,
5200 "description" : "Quarantine life time (days)",
5201 "minimum" : 1,
5202 "optional" : 1,
5203 "type" : "integer",
5204 "typetext" : "<integer> (1 - N)"
5205 },
5206 "mailfrom" : {
5207 "description" : "Text for 'From' header in daily spam report mails.",
5208 "optional" : 1,
5209 "type" : "string",
5210 "typetext" : "<string>"
5211 },
5212 "reportstyle" : {
5213 "default" : "verbose",
5214 "description" : "Spam report style.",
5215 "enum" : [
5216 "none",
5217 "short",
5218 "verbose",
5219 "outlook",
5220 "custom"
5221 ],
5222 "optional" : 1,
5223 "type" : "string"
5224 },
5225 "viewimages" : {
5226 "default" : 1,
5227 "description" : "Allow to view images.",
5228 "optional" : 1,
5229 "type" : "boolean",
5230 "typetext" : "<boolean>"
5231 }
5232 },
5233 "type" : "object"
5234 },
5235 "protected" : 1,
5236 "proxyto" : "master",
5237 "returns" : {
5238 "type" : "null"
5239 }
5240 }
5241 },
5242 "leaf" : 1,
5243 "path" : "/config/spamquar",
5244 "text" : "spamquar"
5245 },
5246 {
5247 "info" : {
5248 "GET" : {
5249 "description" : "Read virusquar configuration properties.",
5250 "method" : "GET",
5251 "name" : "read_virusquar_section",
5252 "parameters" : {
5253 "additionalProperties" : 0
5254 },
5255 "proxyto" : "master",
5256 "returns" : {
5257 "type" : "object"
5258 }
5259 },
5260 "PUT" : {
5261 "description" : "Update virusquar configuration properties.",
5262 "method" : "PUT",
5263 "name" : "update_virusquar_section",
5264 "parameters" : {
5265 "additionalProperties" : 0,
5266 "properties" : {
5267 "allowhrefs" : {
5268 "default" : 1,
5269 "description" : "Allow to view hyperlinks.",
5270 "optional" : 1,
5271 "type" : "boolean",
5272 "typetext" : "<boolean>"
5273 },
5274 "delete" : {
5275 "description" : "A list of settings you want to delete.",
5276 "format" : "pve-configid-list",
5277 "maxLength" : 4096,
5278 "optional" : 1,
5279 "type" : "string",
5280 "typetext" : "<string>"
5281 },
5282 "digest" : {
5283 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
5284 "maxLength" : 40,
5285 "optional" : 1,
5286 "type" : "string",
5287 "typetext" : "<string>"
5288 },
5289 "lifetime" : {
5290 "default" : 7,
5291 "description" : "Quarantine life time (days)",
5292 "minimum" : 1,
5293 "optional" : 1,
5294 "type" : "integer",
5295 "typetext" : "<integer> (1 - N)"
5296 },
5297 "viewimages" : {
5298 "default" : 1,
5299 "description" : "Allow to view images.",
5300 "optional" : 1,
5301 "type" : "boolean",
5302 "typetext" : "<boolean>"
5303 }
5304 },
5305 "type" : "object"
5306 },
5307 "protected" : 1,
5308 "proxyto" : "master",
5309 "returns" : {
5310 "type" : "null"
5311 }
5312 }
5313 },
5314 "leaf" : 1,
5315 "path" : "/config/virusquar",
5316 "text" : "virusquar"
5317 }
5318 ],
5319 "info" : {
5320 "GET" : {
5321 "description" : "Directory index.",
5322 "method" : "GET",
5323 "name" : "index",
5324 "parameters" : {
5325 "additionalProperties" : 0
5326 },
5327 "returns" : {
5328 "items" : {
5329 "properties" : {
5330 "section" : {
5331 "type" : "string"
5332 }
5333 },
5334 "type" : "object"
5335 },
5336 "links" : [
5337 {
5338 "href" : "{section}",
5339 "rel" : "child"
5340 }
5341 ],
5342 "type" : "array"
5343 }
5344 }
5345 },
5346 "leaf" : 0,
5347 "path" : "/config",
5348 "text" : "config"
5349 },
5350 {
5351 "children" : [
5352 {
5353 "children" : [
5354 {
5355 "children" : [
5356 {
5357 "info" : {
5358 "GET" : {
5359 "description" : "Print Postfix queue domain and age distribution.",
5360 "method" : "GET",
5361 "name" : "qshape",
5362 "parameters" : {
5363 "additionalProperties" : 0,
5364 "properties" : {
5365 "node" : {
5366 "description" : "The cluster node name.",
5367 "format" : "pve-node",
5368 "type" : "string",
5369 "typetext" : "<string>"
5370 },
5371 "queue" : {
5372 "default" : "deferred",
5373 "description" : "Postfix queue name.",
5374 "enum" : [
5375 "deferred",
5376 "active",
5377 "incoming",
5378 "hold"
5379 ],
5380 "optional" : 1,
5381 "type" : "string"
5382 }
5383 }
5384 },
5385 "permissions" : {
5386 "check" : [
5387 "admin"
5388 ]
5389 },
5390 "protected" : 1,
5391 "proxyto" : "node",
5392 "returns" : {
5393 "items" : {
5394 "properties" : {},
5395 "type" : "object"
5396 },
5397 "type" : "array"
5398 }
5399 }
5400 },
5401 "leaf" : 1,
5402 "path" : "/nodes/{node}/postfix/qshape",
5403 "text" : "qshape"
5404 },
5405 {
5406 "children" : [
5407 {
5408 "children" : [
5409 {
5410 "info" : {
5411 "DELETE" : {
5412 "description" : "Delete one message with the named queue ID.",
5413 "method" : "DELETE",
5414 "name" : "delete_queued_mail",
5415 "parameters" : {
5416 "additionalProperties" : 0,
5417 "properties" : {
5418 "node" : {
5419 "description" : "The cluster node name.",
5420 "format" : "pve-node",
5421 "type" : "string",
5422 "typetext" : "<string>"
5423 },
5424 "queue" : {
5425 "description" : "Postfix queue name.",
5426 "enum" : [
5427 "deferred",
5428 "active",
5429 "incoming",
5430 "hold"
5431 ],
5432 "type" : "string"
5433 },
5434 "queue_id" : {
5435 "description" : "The Message queue ID.",
5436 "maxLength" : 20,
5437 "minLength" : 8,
5438 "pattern" : "[a-zA-Z0-9]+",
5439 "type" : "string"
5440 }
5441 }
5442 },
5443 "permissions" : {
5444 "check" : [
5445 "admin"
5446 ]
5447 },
5448 "protected" : 1,
5449 "proxyto" : "node",
5450 "returns" : {
5451 "type" : "null"
5452 }
5453 },
5454 "GET" : {
5455 "description" : "Get the contents of a queued mail.",
5456 "method" : "GET",
5457 "name" : "read_queued_mail",
5458 "parameters" : {
5459 "additionalProperties" : 0,
5460 "properties" : {
5461 "body" : {
5462 "default" : 0,
5463 "description" : "Include body content.",
5464 "optional" : 1,
5465 "type" : "boolean",
5466 "typetext" : "<boolean>"
5467 },
5468 "header" : {
5469 "default" : 1,
5470 "description" : "Show message header content.",
5471 "optional" : 1,
5472 "type" : "boolean",
5473 "typetext" : "<boolean>"
5474 },
5475 "node" : {
5476 "description" : "The cluster node name.",
5477 "format" : "pve-node",
5478 "type" : "string",
5479 "typetext" : "<string>"
5480 },
5481 "queue" : {
5482 "description" : "Postfix queue name.",
5483 "enum" : [
5484 "deferred",
5485 "active",
5486 "incoming",
5487 "hold"
5488 ],
5489 "type" : "string"
5490 },
5491 "queue_id" : {
5492 "description" : "The Message queue ID.",
5493 "maxLength" : 20,
5494 "minLength" : 8,
5495 "pattern" : "[a-zA-Z0-9]+",
5496 "type" : "string"
5497 }
5498 }
5499 },
5500 "permissions" : {
5501 "check" : [
5502 "admin"
5503 ]
5504 },
5505 "protected" : 1,
5506 "proxyto" : "node",
5507 "returns" : {
5508 "type" : "string"
5509 }
5510 },
5511 "POST" : {
5512 "description" : "Schedule immediate delivery of deferred mail with the specified queue ID.",
5513 "method" : "POST",
5514 "name" : "flush_queued_mail",
5515 "parameters" : {
5516 "additionalProperties" : 0,
5517 "properties" : {
5518 "node" : {
5519 "description" : "The cluster node name.",
5520 "format" : "pve-node",
5521 "type" : "string",
5522 "typetext" : "<string>"
5523 },
5524 "queue" : {
5525 "description" : "Postfix queue name.",
5526 "enum" : [
5527 "deferred",
5528 "active",
5529 "incoming",
5530 "hold"
5531 ],
5532 "type" : "string"
5533 },
5534 "queue_id" : {
5535 "description" : "The Message queue ID.",
5536 "maxLength" : 20,
5537 "minLength" : 8,
5538 "pattern" : "[a-zA-Z0-9]+",
5539 "type" : "string"
5540 }
5541 }
5542 },
5543 "permissions" : {
5544 "check" : [
5545 "admin"
5546 ]
5547 },
5548 "protected" : 1,
5549 "proxyto" : "node",
5550 "returns" : {
5551 "type" : "null"
5552 }
5553 }
5554 },
5555 "leaf" : 1,
5556 "path" : "/nodes/{node}/postfix/queue/{queue}/{queue_id}",
5557 "text" : "{queue_id}"
5558 }
5559 ],
5560 "info" : {
5561 "DELETE" : {
5562 "description" : "Delete all mails in the queue.",
5563 "method" : "DELETE",
5564 "name" : "delete_queue",
5565 "parameters" : {
5566 "additionalProperties" : 0,
5567 "properties" : {
5568 "node" : {
5569 "description" : "The cluster node name.",
5570 "format" : "pve-node",
5571 "type" : "string",
5572 "typetext" : "<string>"
5573 },
5574 "queue" : {
5575 "description" : "Postfix queue name.",
5576 "enum" : [
5577 "deferred",
5578 "active",
5579 "incoming",
5580 "hold"
5581 ],
5582 "type" : "string"
5583 }
5584 }
5585 },
5586 "permissions" : {
5587 "check" : [
5588 "admin"
5589 ]
5590 },
5591 "protected" : 1,
5592 "proxyto" : "node",
5593 "returns" : {
5594 "type" : "null"
5595 }
5596 },
5597 "GET" : {
5598 "description" : "List the mail queue for a specific domain.",
5599 "method" : "GET",
5600 "name" : "mailq",
5601 "parameters" : {
5602 "additionalProperties" : 0,
5603 "properties" : {
5604 "filter" : {
5605 "description" : "Filter string.",
5606 "maxLength" : 64,
5607 "optional" : 1,
5608 "type" : "string",
5609 "typetext" : "<string>"
5610 },
5611 "limit" : {
5612 "minimum" : 0,
5613 "optional" : 1,
5614 "type" : "integer",
5615 "typetext" : "<integer> (0 - N)"
5616 },
5617 "node" : {
5618 "description" : "The cluster node name.",
5619 "format" : "pve-node",
5620 "type" : "string",
5621 "typetext" : "<string>"
5622 },
5623 "queue" : {
5624 "description" : "Postfix queue name.",
5625 "enum" : [
5626 "deferred",
5627 "active",
5628 "incoming",
5629 "hold"
5630 ],
5631 "type" : "string"
5632 },
5633 "start" : {
5634 "minimum" : 0,
5635 "optional" : 1,
5636 "type" : "integer",
5637 "typetext" : "<integer> (0 - N)"
5638 }
5639 }
5640 },
5641 "permissions" : {
5642 "check" : [
5643 "admin"
5644 ]
5645 },
5646 "protected" : 1,
5647 "proxyto" : "node",
5648 "returns" : {
5649 "items" : {
5650 "properties" : {},
5651 "type" : "object"
5652 },
5653 "links" : [
5654 {
5655 "href" : "{queue_id}",
5656 "rel" : "child"
5657 }
5658 ],
5659 "type" : "array"
5660 }
5661 }
5662 },
5663 "leaf" : 0,
5664 "path" : "/nodes/{node}/postfix/queue/{queue}",
5665 "text" : "{queue}"
5666 }
5667 ],
5668 "info" : {
5669 "GET" : {
5670 "description" : "Directory index.",
5671 "method" : "GET",
5672 "name" : "queue_index",
5673 "parameters" : {
5674 "additionalProperties" : 0,
5675 "properties" : {
5676 "node" : {
5677 "description" : "The cluster node name.",
5678 "format" : "pve-node",
5679 "type" : "string",
5680 "typetext" : "<string>"
5681 }
5682 }
5683 },
5684 "permissions" : {
5685 "user" : "all"
5686 },
5687 "returns" : {
5688 "items" : {
5689 "properties" : {},
5690 "type" : "object"
5691 },
5692 "links" : [
5693 {
5694 "href" : "{name}",
5695 "rel" : "child"
5696 }
5697 ],
5698 "type" : "array"
5699 }
5700 }
5701 },
5702 "leaf" : 0,
5703 "path" : "/nodes/{node}/postfix/queue",
5704 "text" : "queue"
5705 },
5706 {
5707 "info" : {
5708 "POST" : {
5709 "description" : "Flush the queue: attempt to deliver all queued mail.",
5710 "method" : "POST",
5711 "name" : "flush_queues",
5712 "parameters" : {
5713 "additionalProperties" : 0,
5714 "properties" : {
5715 "node" : {
5716 "description" : "The cluster node name.",
5717 "format" : "pve-node",
5718 "type" : "string",
5719 "typetext" : "<string>"
5720 }
5721 }
5722 },
5723 "permissions" : {
5724 "check" : [
5725 "admin"
5726 ]
5727 },
5728 "protected" : 1,
5729 "proxyto" : "node",
5730 "returns" : {
5731 "type" : "null"
5732 }
5733 }
5734 },
5735 "leaf" : 1,
5736 "path" : "/nodes/{node}/postfix/flush_queues",
5737 "text" : "flush_queues"
5738 },
5739 {
5740 "info" : {
5741 "POST" : {
5742 "description" : "Discards the address verification cache.",
5743 "method" : "POST",
5744 "name" : "discard_verify_cache",
5745 "parameters" : {
5746 "additionalProperties" : 0,
5747 "properties" : {
5748 "node" : {
5749 "description" : "The cluster node name.",
5750 "format" : "pve-node",
5751 "type" : "string",
5752 "typetext" : "<string>"
5753 }
5754 }
5755 },
5756 "permissions" : {
5757 "check" : [
5758 "admin"
5759 ]
5760 },
5761 "protected" : 1,
5762 "proxyto" : "node",
5763 "returns" : {
5764 "type" : "null"
5765 }
5766 }
5767 },
5768 "leaf" : 1,
5769 "path" : "/nodes/{node}/postfix/discard_verify_cache",
5770 "text" : "discard_verify_cache"
5771 }
5772 ],
5773 "info" : {
5774 "GET" : {
5775 "description" : "Directory index.",
5776 "method" : "GET",
5777 "name" : "index",
5778 "parameters" : {
5779 "additionalProperties" : 0,
5780 "properties" : {
5781 "node" : {
5782 "description" : "The cluster node name.",
5783 "format" : "pve-node",
5784 "type" : "string",
5785 "typetext" : "<string>"
5786 }
5787 }
5788 },
5789 "permissions" : {
5790 "user" : "all"
5791 },
5792 "returns" : {
5793 "items" : {
5794 "properties" : {},
5795 "type" : "object"
5796 },
5797 "links" : [
5798 {
5799 "href" : "{name}",
5800 "rel" : "child"
5801 }
5802 ],
5803 "type" : "array"
5804 }
5805 }
5806 },
5807 "leaf" : 0,
5808 "path" : "/nodes/{node}/postfix",
5809 "text" : "postfix"
5810 },
5811 {
5812 "children" : [
5813 {
5814 "info" : {
5815 "GET" : {
5816 "description" : "ClamAV virus database status.",
5817 "method" : "GET",
5818 "name" : "database_status",
5819 "parameters" : {
5820 "additionalProperties" : 0,
5821 "properties" : {
5822 "node" : {
5823 "description" : "The cluster node name.",
5824 "format" : "pve-node",
5825 "type" : "string",
5826 "typetext" : "<string>"
5827 }
5828 }
5829 },
5830 "returns" : {
5831 "items" : {
5832 "properties" : {
5833 "build_time" : {
5834 "type" : "string"
5835 },
5836 "nsigs" : {
5837 "type" : "integer"
5838 },
5839 "type" : {
5840 "type" : "string"
5841 },
5842 "version" : {
5843 "optional" : 1,
5844 "type" : "string"
5845 }
5846 },
5847 "type" : "object"
5848 },
5849 "type" : "array"
5850 }
5851 },
5852 "POST" : {
5853 "description" : "Update ClamAV virus databases.",
5854 "method" : "POST",
5855 "name" : "update_database",
5856 "parameters" : {
5857 "additionalProperties" : 0,
5858 "properties" : {
5859 "node" : {
5860 "description" : "The cluster node name.",
5861 "format" : "pve-node",
5862 "type" : "string",
5863 "typetext" : "<string>"
5864 }
5865 }
5866 },
5867 "protected" : 1,
5868 "returns" : {
5869 "type" : "string"
5870 }
5871 }
5872 },
5873 "leaf" : 1,
5874 "path" : "/nodes/{node}/clamav/database",
5875 "text" : "database"
5876 }
5877 ],
5878 "info" : {
5879 "GET" : {
5880 "description" : "Directory index.",
5881 "method" : "GET",
5882 "name" : "index",
5883 "parameters" : {
5884 "additionalProperties" : 0,
5885 "properties" : {
5886 "node" : {
5887 "description" : "The cluster node name.",
5888 "format" : "pve-node",
5889 "type" : "string",
5890 "typetext" : "<string>"
5891 }
5892 }
5893 },
5894 "protected" : 1,
5895 "proxyto" : "node",
5896 "returns" : {
5897 "items" : {
5898 "properties" : {},
5899 "type" : "object"
5900 },
5901 "links" : [
5902 {
5903 "href" : "{subdir}",
5904 "rel" : "child"
5905 }
5906 ],
5907 "type" : "array"
5908 }
5909 }
5910 },
5911 "leaf" : 0,
5912 "path" : "/nodes/{node}/clamav",
5913 "text" : "clamav"
5914 },
5915 {
5916 "children" : [
5917 {
5918 "info" : {
5919 "DELETE" : {
5920 "description" : "Delete network device configuration",
5921 "method" : "DELETE",
5922 "name" : "delete_network",
5923 "parameters" : {
5924 "additionalProperties" : 0,
5925 "properties" : {
5926 "iface" : {
5927 "description" : "Network interface name.",
5928 "format" : "pve-iface",
5929 "maxLength" : 20,
5930 "minLength" : 2,
5931 "type" : "string",
5932 "typetext" : "<string>"
5933 },
5934 "node" : {
5935 "description" : "The cluster node name.",
5936 "format" : "pve-node",
5937 "type" : "string",
5938 "typetext" : "<string>"
5939 }
5940 }
5941 },
5942 "protected" : 1,
5943 "proxyto" : "node",
5944 "returns" : {
5945 "type" : "null"
5946 }
5947 },
5948 "GET" : {
5949 "description" : "Read network device configuration",
5950 "method" : "GET",
5951 "name" : "network_config",
5952 "parameters" : {
5953 "additionalProperties" : 0,
5954 "properties" : {
5955 "iface" : {
5956 "description" : "Network interface name.",
5957 "format" : "pve-iface",
5958 "maxLength" : 20,
5959 "minLength" : 2,
5960 "type" : "string",
5961 "typetext" : "<string>"
5962 },
5963 "node" : {
5964 "description" : "The cluster node name.",
5965 "format" : "pve-node",
5966 "type" : "string",
5967 "typetext" : "<string>"
5968 }
5969 }
5970 },
5971 "proxyto" : "node",
5972 "returns" : {
5973 "properties" : {
5974 "method" : {
5975 "type" : "string"
5976 },
5977 "type" : {
5978 "type" : "string"
5979 }
5980 },
5981 "type" : "object"
5982 }
5983 },
5984 "PUT" : {
5985 "description" : "Update network device configuration",
5986 "method" : "PUT",
5987 "name" : "update_network",
5988 "parameters" : {
5989 "additionalProperties" : 0,
5990 "properties" : {
5991 "address" : {
5992 "description" : "IP address.",
5993 "format" : "ipv4",
5994 "optional" : 1,
5995 "requires" : "netmask",
5996 "type" : "string",
5997 "typetext" : "<string>"
5998 },
5999 "address6" : {
6000 "description" : "IP address.",
6001 "format" : "ipv6",
6002 "optional" : 1,
6003 "requires" : "netmask6",
6004 "type" : "string",
6005 "typetext" : "<string>"
6006 },
6007 "autostart" : {
6008 "description" : "Automatically start interface on boot.",
6009 "optional" : 1,
6010 "type" : "boolean",
6011 "typetext" : "<boolean>"
6012 },
6013 "bond_mode" : {
6014 "description" : "Bonding mode.",
6015 "enum" : [
6016 "balance-rr",
6017 "active-backup",
6018 "balance-xor",
6019 "broadcast",
6020 "802.3ad",
6021 "balance-tlb",
6022 "balance-alb",
6023 "balance-slb",
6024 "lacp-balance-slb",
6025 "lacp-balance-tcp"
6026 ],
6027 "optional" : 1,
6028 "type" : "string"
6029 },
6030 "bond_xmit_hash_policy" : {
6031 "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.",
6032 "enum" : [
6033 "layer2",
6034 "layer2+3",
6035 "layer3+4"
6036 ],
6037 "optional" : 1,
6038 "type" : "string"
6039 },
6040 "bridge_ports" : {
6041 "description" : "Specify the iterfaces you want to add to your bridge.",
6042 "format" : "pve-iface-list",
6043 "optional" : 1,
6044 "type" : "string",
6045 "typetext" : "<string>"
6046 },
6047 "bridge_vlan_aware" : {
6048 "description" : "Enable bridge vlan support.",
6049 "optional" : 1,
6050 "type" : "boolean",
6051 "typetext" : "<boolean>"
6052 },
6053 "comments" : {
6054 "description" : "Comments",
6055 "optional" : 1,
6056 "type" : "string",
6057 "typetext" : "<string>"
6058 },
6059 "comments6" : {
6060 "description" : "Comments",
6061 "optional" : 1,
6062 "type" : "string",
6063 "typetext" : "<string>"
6064 },
6065 "delete" : {
6066 "description" : "A list of settings you want to delete.",
6067 "format" : "pve-configid-list",
6068 "optional" : 1,
6069 "type" : "string",
6070 "typetext" : "<string>"
6071 },
6072 "gateway" : {
6073 "description" : "Default gateway address.",
6074 "format" : "ipv4",
6075 "optional" : 1,
6076 "type" : "string",
6077 "typetext" : "<string>"
6078 },
6079 "gateway6" : {
6080 "description" : "Default ipv6 gateway address.",
6081 "format" : "ipv6",
6082 "optional" : 1,
6083 "type" : "string",
6084 "typetext" : "<string>"
6085 },
6086 "iface" : {
6087 "description" : "Network interface name.",
6088 "format" : "pve-iface",
6089 "maxLength" : 20,
6090 "minLength" : 2,
6091 "type" : "string",
6092 "typetext" : "<string>"
6093 },
6094 "netmask" : {
6095 "description" : "Network mask.",
6096 "format" : "ipv4mask",
6097 "optional" : 1,
6098 "requires" : "address",
6099 "type" : "string",
6100 "typetext" : "<string>"
6101 },
6102 "netmask6" : {
6103 "description" : "Network mask.",
6104 "maximum" : 128,
6105 "minimum" : 0,
6106 "optional" : 1,
6107 "requires" : "address6",
6108 "type" : "integer",
6109 "typetext" : "<integer> (0 - 128)"
6110 },
6111 "node" : {
6112 "description" : "The cluster node name.",
6113 "format" : "pve-node",
6114 "type" : "string",
6115 "typetext" : "<string>"
6116 },
6117 "ovs_bonds" : {
6118 "description" : "Specify the interfaces used by the bonding device.",
6119 "format" : "pve-iface-list",
6120 "optional" : 1,
6121 "type" : "string",
6122 "typetext" : "<string>"
6123 },
6124 "ovs_bridge" : {
6125 "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.",
6126 "format" : "pve-iface",
6127 "optional" : 1,
6128 "type" : "string",
6129 "typetext" : "<string>"
6130 },
6131 "ovs_options" : {
6132 "description" : "OVS interface options.",
6133 "maxLength" : 1024,
6134 "optional" : 1,
6135 "type" : "string",
6136 "typetext" : "<string>"
6137 },
6138 "ovs_ports" : {
6139 "description" : "Specify the iterfaces you want to add to your bridge.",
6140 "format" : "pve-iface-list",
6141 "optional" : 1,
6142 "type" : "string",
6143 "typetext" : "<string>"
6144 },
6145 "ovs_tag" : {
6146 "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)",
6147 "maximum" : 4094,
6148 "minimum" : 1,
6149 "optional" : 1,
6150 "type" : "integer",
6151 "typetext" : "<integer> (1 - 4094)"
6152 },
6153 "slaves" : {
6154 "description" : "Specify the interfaces used by the bonding device.",
6155 "format" : "pve-iface-list",
6156 "optional" : 1,
6157 "type" : "string",
6158 "typetext" : "<string>"
6159 },
6160 "type" : {
6161 "description" : "Network interface type",
6162 "enum" : [
6163 "bridge",
6164 "bond",
6165 "eth",
6166 "alias",
6167 "vlan",
6168 "OVSBridge",
6169 "OVSBond",
6170 "OVSPort",
6171 "OVSIntPort",
6172 "unknown"
6173 ],
6174 "type" : "string"
6175 }
6176 }
6177 },
6178 "protected" : 1,
6179 "proxyto" : "node",
6180 "returns" : {
6181 "type" : "null"
6182 }
6183 }
6184 },
6185 "leaf" : 1,
6186 "path" : "/nodes/{node}/network/{iface}",
6187 "text" : "{iface}"
6188 }
6189 ],
6190 "info" : {
6191 "DELETE" : {
6192 "description" : "Revert network configuration changes.",
6193 "method" : "DELETE",
6194 "name" : "revert_network_changes",
6195 "parameters" : {
6196 "additionalProperties" : 0,
6197 "properties" : {
6198 "node" : {
6199 "description" : "The cluster node name.",
6200 "format" : "pve-node",
6201 "type" : "string",
6202 "typetext" : "<string>"
6203 }
6204 }
6205 },
6206 "protected" : 1,
6207 "proxyto" : "node",
6208 "returns" : {
6209 "type" : "null"
6210 }
6211 },
6212 "GET" : {
6213 "description" : "List available networks",
6214 "method" : "GET",
6215 "name" : "index",
6216 "parameters" : {
6217 "additionalProperties" : 0,
6218 "properties" : {
6219 "node" : {
6220 "description" : "The cluster node name.",
6221 "format" : "pve-node",
6222 "type" : "string",
6223 "typetext" : "<string>"
6224 },
6225 "type" : {
6226 "description" : "Only list specific interface types.",
6227 "enum" : [
6228 "bridge",
6229 "bond",
6230 "eth",
6231 "alias",
6232 "vlan",
6233 "OVSBridge",
6234 "OVSBond",
6235 "OVSPort",
6236 "OVSIntPort",
6237 "any_bridge"
6238 ],
6239 "optional" : 1,
6240 "type" : "string"
6241 }
6242 }
6243 },
6244 "proxyto" : "node",
6245 "returns" : {
6246 "items" : {
6247 "properties" : {},
6248 "type" : "object"
6249 },
6250 "links" : [
6251 {
6252 "href" : "{iface}",
6253 "rel" : "child"
6254 }
6255 ],
6256 "type" : "array"
6257 }
6258 },
6259 "POST" : {
6260 "description" : "Create network device configuration",
6261 "method" : "POST",
6262 "name" : "create_network",
6263 "parameters" : {
6264 "additionalProperties" : 0,
6265 "properties" : {
6266 "address" : {
6267 "description" : "IP address.",
6268 "format" : "ipv4",
6269 "optional" : 1,
6270 "requires" : "netmask",
6271 "type" : "string",
6272 "typetext" : "<string>"
6273 },
6274 "address6" : {
6275 "description" : "IP address.",
6276 "format" : "ipv6",
6277 "optional" : 1,
6278 "requires" : "netmask6",
6279 "type" : "string",
6280 "typetext" : "<string>"
6281 },
6282 "autostart" : {
6283 "description" : "Automatically start interface on boot.",
6284 "optional" : 1,
6285 "type" : "boolean",
6286 "typetext" : "<boolean>"
6287 },
6288 "bond_mode" : {
6289 "description" : "Bonding mode.",
6290 "enum" : [
6291 "balance-rr",
6292 "active-backup",
6293 "balance-xor",
6294 "broadcast",
6295 "802.3ad",
6296 "balance-tlb",
6297 "balance-alb",
6298 "balance-slb",
6299 "lacp-balance-slb",
6300 "lacp-balance-tcp"
6301 ],
6302 "optional" : 1,
6303 "type" : "string"
6304 },
6305 "bond_xmit_hash_policy" : {
6306 "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.",
6307 "enum" : [
6308 "layer2",
6309 "layer2+3",
6310 "layer3+4"
6311 ],
6312 "optional" : 1,
6313 "type" : "string"
6314 },
6315 "bridge_ports" : {
6316 "description" : "Specify the iterfaces you want to add to your bridge.",
6317 "format" : "pve-iface-list",
6318 "optional" : 1,
6319 "type" : "string",
6320 "typetext" : "<string>"
6321 },
6322 "bridge_vlan_aware" : {
6323 "description" : "Enable bridge vlan support.",
6324 "optional" : 1,
6325 "type" : "boolean",
6326 "typetext" : "<boolean>"
6327 },
6328 "comments" : {
6329 "description" : "Comments",
6330 "optional" : 1,
6331 "type" : "string",
6332 "typetext" : "<string>"
6333 },
6334 "comments6" : {
6335 "description" : "Comments",
6336 "optional" : 1,
6337 "type" : "string",
6338 "typetext" : "<string>"
6339 },
6340 "gateway" : {
6341 "description" : "Default gateway address.",
6342 "format" : "ipv4",
6343 "optional" : 1,
6344 "type" : "string",
6345 "typetext" : "<string>"
6346 },
6347 "gateway6" : {
6348 "description" : "Default ipv6 gateway address.",
6349 "format" : "ipv6",
6350 "optional" : 1,
6351 "type" : "string",
6352 "typetext" : "<string>"
6353 },
6354 "iface" : {
6355 "description" : "Network interface name.",
6356 "format" : "pve-iface",
6357 "maxLength" : 20,
6358 "minLength" : 2,
6359 "type" : "string",
6360 "typetext" : "<string>"
6361 },
6362 "netmask" : {
6363 "description" : "Network mask.",
6364 "format" : "ipv4mask",
6365 "optional" : 1,
6366 "requires" : "address",
6367 "type" : "string",
6368 "typetext" : "<string>"
6369 },
6370 "netmask6" : {
6371 "description" : "Network mask.",
6372 "maximum" : 128,
6373 "minimum" : 0,
6374 "optional" : 1,
6375 "requires" : "address6",
6376 "type" : "integer",
6377 "typetext" : "<integer> (0 - 128)"
6378 },
6379 "node" : {
6380 "description" : "The cluster node name.",
6381 "format" : "pve-node",
6382 "type" : "string",
6383 "typetext" : "<string>"
6384 },
6385 "ovs_bonds" : {
6386 "description" : "Specify the interfaces used by the bonding device.",
6387 "format" : "pve-iface-list",
6388 "optional" : 1,
6389 "type" : "string",
6390 "typetext" : "<string>"
6391 },
6392 "ovs_bridge" : {
6393 "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.",
6394 "format" : "pve-iface",
6395 "optional" : 1,
6396 "type" : "string",
6397 "typetext" : "<string>"
6398 },
6399 "ovs_options" : {
6400 "description" : "OVS interface options.",
6401 "maxLength" : 1024,
6402 "optional" : 1,
6403 "type" : "string",
6404 "typetext" : "<string>"
6405 },
6406 "ovs_ports" : {
6407 "description" : "Specify the iterfaces you want to add to your bridge.",
6408 "format" : "pve-iface-list",
6409 "optional" : 1,
6410 "type" : "string",
6411 "typetext" : "<string>"
6412 },
6413 "ovs_tag" : {
6414 "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)",
6415 "maximum" : 4094,
6416 "minimum" : 1,
6417 "optional" : 1,
6418 "type" : "integer",
6419 "typetext" : "<integer> (1 - 4094)"
6420 },
6421 "slaves" : {
6422 "description" : "Specify the interfaces used by the bonding device.",
6423 "format" : "pve-iface-list",
6424 "optional" : 1,
6425 "type" : "string",
6426 "typetext" : "<string>"
6427 },
6428 "type" : {
6429 "description" : "Network interface type",
6430 "enum" : [
6431 "bridge",
6432 "bond",
6433 "eth",
6434 "alias",
6435 "vlan",
6436 "OVSBridge",
6437 "OVSBond",
6438 "OVSPort",
6439 "OVSIntPort",
6440 "unknown"
6441 ],
6442 "type" : "string"
6443 }
6444 }
6445 },
6446 "protected" : 1,
6447 "proxyto" : "node",
6448 "returns" : {
6449 "type" : "null"
6450 }
6451 }
6452 },
6453 "leaf" : 0,
6454 "path" : "/nodes/{node}/network",
6455 "text" : "network"
6456 },
6457 {
6458 "children" : [
6459 {
6460 "children" : [
6461 {
6462 "info" : {
6463 "GET" : {
6464 "description" : "Read task log.",
6465 "method" : "GET",
6466 "name" : "read_task_log",
6467 "parameters" : {
6468 "additionalProperties" : 0,
6469 "properties" : {
6470 "limit" : {
6471 "minimum" : 0,
6472 "optional" : 1,
6473 "type" : "integer",
6474 "typetext" : "<integer> (0 - N)"
6475 },
6476 "node" : {
6477 "description" : "The cluster node name.",
6478 "format" : "pve-node",
6479 "type" : "string",
6480 "typetext" : "<string>"
6481 },
6482 "start" : {
6483 "minimum" : 0,
6484 "optional" : 1,
6485 "type" : "integer",
6486 "typetext" : "<integer> (0 - N)"
6487 },
6488 "upid" : {
6489 "type" : "string",
6490 "typetext" : "<string>"
6491 }
6492 }
6493 },
6494 "protected" : 1,
6495 "proxyto" : "node",
6496 "returns" : {
6497 "items" : {
6498 "properties" : {
6499 "n" : {
6500 "description" : "Line number",
6501 "type" : "integer"
6502 },
6503 "t" : {
6504 "description" : "Line text",
6505 "type" : "string"
6506 }
6507 },
6508 "type" : "object"
6509 },
6510 "type" : "array"
6511 }
6512 }
6513 },
6514 "leaf" : 1,
6515 "path" : "/nodes/{node}/tasks/{upid}/log",
6516 "text" : "log"
6517 },
6518 {
6519 "info" : {
6520 "GET" : {
6521 "description" : "Read task status.",
6522 "method" : "GET",
6523 "name" : "read_task_status",
6524 "parameters" : {
6525 "additionalProperties" : 0,
6526 "properties" : {
6527 "node" : {
6528 "description" : "The cluster node name.",
6529 "format" : "pve-node",
6530 "type" : "string",
6531 "typetext" : "<string>"
6532 },
6533 "upid" : {
6534 "type" : "string",
6535 "typetext" : "<string>"
6536 }
6537 }
6538 },
6539 "protected" : 1,
6540 "proxyto" : "node",
6541 "returns" : {
6542 "properties" : {
6543 "pid" : {
6544 "type" : "integer"
6545 },
6546 "status" : {
6547 "enum" : [
6548 "running",
6549 "stopped"
6550 ],
6551 "type" : "string"
6552 }
6553 },
6554 "type" : "object"
6555 }
6556 }
6557 },
6558 "leaf" : 1,
6559 "path" : "/nodes/{node}/tasks/{upid}/status",
6560 "text" : "status"
6561 }
6562 ],
6563 "info" : {
6564 "DELETE" : {
6565 "description" : "Stop a task.",
6566 "method" : "DELETE",
6567 "name" : "stop_task",
6568 "parameters" : {
6569 "additionalProperties" : 0,
6570 "properties" : {
6571 "node" : {
6572 "description" : "The cluster node name.",
6573 "format" : "pve-node",
6574 "type" : "string",
6575 "typetext" : "<string>"
6576 },
6577 "upid" : {
6578 "type" : "string",
6579 "typetext" : "<string>"
6580 }
6581 }
6582 },
6583 "protected" : 1,
6584 "proxyto" : "node",
6585 "returns" : {
6586 "type" : "null"
6587 }
6588 },
6589 "GET" : {
6590 "description" : "",
6591 "method" : "GET",
6592 "name" : "upid_index",
6593 "parameters" : {
6594 "additionalProperties" : 0,
6595 "properties" : {
6596 "node" : {
6597 "description" : "The cluster node name.",
6598 "format" : "pve-node",
6599 "type" : "string",
6600 "typetext" : "<string>"
6601 },
6602 "upid" : {
6603 "type" : "string",
6604 "typetext" : "<string>"
6605 }
6606 }
6607 },
6608 "returns" : {
6609 "items" : {
6610 "properties" : {},
6611 "type" : "object"
6612 },
6613 "links" : [
6614 {
6615 "href" : "{name}",
6616 "rel" : "child"
6617 }
6618 ],
6619 "type" : "array"
6620 }
6621 }
6622 },
6623 "leaf" : 0,
6624 "path" : "/nodes/{node}/tasks/{upid}",
6625 "text" : "{upid}"
6626 }
6627 ],
6628 "info" : {
6629 "GET" : {
6630 "description" : "Read task list for one node (finished tasks).",
6631 "method" : "GET",
6632 "name" : "node_tasks",
6633 "parameters" : {
6634 "additionalProperties" : 0,
6635 "properties" : {
6636 "errors" : {
6637 "optional" : 1,
6638 "type" : "boolean",
6639 "typetext" : "<boolean>"
6640 },
6641 "limit" : {
6642 "minimum" : 0,
6643 "optional" : 1,
6644 "type" : "integer",
6645 "typetext" : "<integer> (0 - N)"
6646 },
6647 "node" : {
6648 "description" : "The cluster node name.",
6649 "format" : "pve-node",
6650 "type" : "string",
6651 "typetext" : "<string>"
6652 },
6653 "start" : {
6654 "minimum" : 0,
6655 "optional" : 1,
6656 "type" : "integer",
6657 "typetext" : "<integer> (0 - N)"
6658 },
6659 "userfilter" : {
6660 "optional" : 1,
6661 "type" : "string",
6662 "typetext" : "<string>"
6663 }
6664 }
6665 },
6666 "proxyto" : "node",
6667 "returns" : {
6668 "items" : {
6669 "properties" : {
6670 "upid" : {
6671 "type" : "string"
6672 }
6673 },
6674 "type" : "object"
6675 },
6676 "links" : [
6677 {
6678 "href" : "{upid}",
6679 "rel" : "child"
6680 }
6681 ],
6682 "type" : "array"
6683 }
6684 }
6685 },
6686 "leaf" : 0,
6687 "path" : "/nodes/{node}/tasks",
6688 "text" : "tasks"
6689 },
6690 {
6691 "children" : [
6692 {
6693 "children" : [
6694 {
6695 "info" : {
6696 "GET" : {
6697 "description" : "Read service properties",
6698 "method" : "GET",
6699 "name" : "service_state",
6700 "parameters" : {
6701 "additionalProperties" : 0,
6702 "properties" : {
6703 "node" : {
6704 "description" : "The cluster node name.",
6705 "format" : "pve-node",
6706 "type" : "string",
6707 "typetext" : "<string>"
6708 },
6709 "service" : {
6710 "description" : "Service ID",
6711 "enum" : [
6712 "clamav-daemon",
6713 "clamav-freshclam",
6714 "pmgproxy",
6715 "pmgdaemon",
6716 "pmgpolicy",
6717 "pmg-smtp-filter",
6718 "sshd",
6719 "syslog",
6720 "postfix",
6721 "systemd-timesyncd",
6722 "pmg-hourly",
6723 "pmg-daily"
6724 ],
6725 "type" : "string"
6726 }
6727 }
6728 },
6729 "protected" : 1,
6730 "proxyto" : "node",
6731 "returns" : {
6732 "properties" : {},
6733 "type" : "object"
6734 }
6735 }
6736 },
6737 "leaf" : 1,
6738 "path" : "/nodes/{node}/services/{service}/state",
6739 "text" : "state"
6740 },
6741 {
6742 "info" : {
6743 "POST" : {
6744 "description" : "Start service.",
6745 "method" : "POST",
6746 "name" : "service_start",
6747 "parameters" : {
6748 "additionalProperties" : 0,
6749 "properties" : {
6750 "node" : {
6751 "description" : "The cluster node name.",
6752 "format" : "pve-node",
6753 "type" : "string",
6754 "typetext" : "<string>"
6755 },
6756 "service" : {
6757 "description" : "Service ID",
6758 "enum" : [
6759 "clamav-daemon",
6760 "clamav-freshclam",
6761 "pmgproxy",
6762 "pmgdaemon",
6763 "pmgpolicy",
6764 "pmg-smtp-filter",
6765 "sshd",
6766 "syslog",
6767 "postfix",
6768 "systemd-timesyncd",
6769 "pmg-hourly",
6770 "pmg-daily"
6771 ],
6772 "type" : "string"
6773 }
6774 }
6775 },
6776 "protected" : 1,
6777 "proxyto" : "node",
6778 "returns" : {
6779 "type" : "string"
6780 }
6781 }
6782 },
6783 "leaf" : 1,
6784 "path" : "/nodes/{node}/services/{service}/start",
6785 "text" : "start"
6786 },
6787 {
6788 "info" : {
6789 "POST" : {
6790 "description" : "Stop service.",
6791 "method" : "POST",
6792 "name" : "service_stop",
6793 "parameters" : {
6794 "additionalProperties" : 0,
6795 "properties" : {
6796 "node" : {
6797 "description" : "The cluster node name.",
6798 "format" : "pve-node",
6799 "type" : "string",
6800 "typetext" : "<string>"
6801 },
6802 "service" : {
6803 "description" : "Service ID",
6804 "enum" : [
6805 "clamav-daemon",
6806 "clamav-freshclam",
6807 "pmgproxy",
6808 "pmgdaemon",
6809 "pmgpolicy",
6810 "pmg-smtp-filter",
6811 "sshd",
6812 "syslog",
6813 "postfix",
6814 "systemd-timesyncd",
6815 "pmg-hourly",
6816 "pmg-daily"
6817 ],
6818 "type" : "string"
6819 }
6820 }
6821 },
6822 "protected" : 1,
6823 "proxyto" : "node",
6824 "returns" : {
6825 "type" : "string"
6826 }
6827 }
6828 },
6829 "leaf" : 1,
6830 "path" : "/nodes/{node}/services/{service}/stop",
6831 "text" : "stop"
6832 },
6833 {
6834 "info" : {
6835 "POST" : {
6836 "description" : "Restart service.",
6837 "method" : "POST",
6838 "name" : "service_restart",
6839 "parameters" : {
6840 "additionalProperties" : 0,
6841 "properties" : {
6842 "node" : {
6843 "description" : "The cluster node name.",
6844 "format" : "pve-node",
6845 "type" : "string",
6846 "typetext" : "<string>"
6847 },
6848 "service" : {
6849 "description" : "Service ID",
6850 "enum" : [
6851 "clamav-daemon",
6852 "clamav-freshclam",
6853 "pmgproxy",
6854 "pmgdaemon",
6855 "pmgpolicy",
6856 "pmg-smtp-filter",
6857 "sshd",
6858 "syslog",
6859 "postfix",
6860 "systemd-timesyncd",
6861 "pmg-hourly",
6862 "pmg-daily"
6863 ],
6864 "type" : "string"
6865 }
6866 }
6867 },
6868 "protected" : 1,
6869 "proxyto" : "node",
6870 "returns" : {
6871 "type" : "string"
6872 }
6873 }
6874 },
6875 "leaf" : 1,
6876 "path" : "/nodes/{node}/services/{service}/restart",
6877 "text" : "restart"
6878 },
6879 {
6880 "info" : {
6881 "POST" : {
6882 "description" : "Reload service.",
6883 "method" : "POST",
6884 "name" : "service_reload",
6885 "parameters" : {
6886 "additionalProperties" : 0,
6887 "properties" : {
6888 "node" : {
6889 "description" : "The cluster node name.",
6890 "format" : "pve-node",
6891 "type" : "string",
6892 "typetext" : "<string>"
6893 },
6894 "service" : {
6895 "description" : "Service ID",
6896 "enum" : [
6897 "clamav-daemon",
6898 "clamav-freshclam",
6899 "pmgproxy",
6900 "pmgdaemon",
6901 "pmgpolicy",
6902 "pmg-smtp-filter",
6903 "sshd",
6904 "syslog",
6905 "postfix",
6906 "systemd-timesyncd",
6907 "pmg-hourly",
6908 "pmg-daily"
6909 ],
6910 "type" : "string"
6911 }
6912 }
6913 },
6914 "protected" : 1,
6915 "proxyto" : "node",
6916 "returns" : {
6917 "type" : "string"
6918 }
6919 }
6920 },
6921 "leaf" : 1,
6922 "path" : "/nodes/{node}/services/{service}/reload",
6923 "text" : "reload"
6924 }
6925 ],
6926 "info" : {
6927 "GET" : {
6928 "description" : "Directory index",
6929 "method" : "GET",
6930 "name" : "srvcmdidx",
6931 "parameters" : {
6932 "additionalProperties" : 0,
6933 "properties" : {
6934 "node" : {
6935 "description" : "The cluster node name.",
6936 "format" : "pve-node",
6937 "type" : "string",
6938 "typetext" : "<string>"
6939 },
6940 "service" : {
6941 "description" : "Service ID",
6942 "enum" : [
6943 "clamav-daemon",
6944 "clamav-freshclam",
6945 "pmgproxy",
6946 "pmgdaemon",
6947 "pmgpolicy",
6948 "pmg-smtp-filter",
6949 "sshd",
6950 "syslog",
6951 "postfix",
6952 "systemd-timesyncd",
6953 "pmg-hourly",
6954 "pmg-daily"
6955 ],
6956 "type" : "string"
6957 }
6958 }
6959 },
6960 "returns" : {
6961 "items" : {
6962 "properties" : {
6963 "subdir" : {
6964 "type" : "string"
6965 }
6966 },
6967 "type" : "object"
6968 },
6969 "links" : [
6970 {
6971 "href" : "{subdir}",
6972 "rel" : "child"
6973 }
6974 ],
6975 "type" : "array"
6976 }
6977 }
6978 },
6979 "leaf" : 0,
6980 "path" : "/nodes/{node}/services/{service}",
6981 "text" : "{service}"
6982 }
6983 ],
6984 "info" : {
6985 "GET" : {
6986 "description" : "Service list.",
6987 "method" : "GET",
6988 "name" : "index",
6989 "parameters" : {
6990 "additionalProperties" : 0,
6991 "properties" : {
6992 "node" : {
6993 "description" : "The cluster node name.",
6994 "format" : "pve-node",
6995 "type" : "string",
6996 "typetext" : "<string>"
6997 }
6998 }
6999 },
7000 "protected" : 1,
7001 "proxyto" : "node",
7002 "returns" : {
7003 "items" : {
7004 "properties" : {},
7005 "type" : "object"
7006 },
7007 "links" : [
7008 {
7009 "href" : "{service}",
7010 "rel" : "child"
7011 }
7012 ],
7013 "type" : "array"
7014 }
7015 }
7016 },
7017 "leaf" : 0,
7018 "path" : "/nodes/{node}/services",
7019 "text" : "services"
7020 },
7021 {
7022 "info" : {
7023 "GET" : {
7024 "description" : "Read node RRD statistics",
7025 "method" : "GET",
7026 "name" : "rrddata",
7027 "parameters" : {
7028 "additionalProperties" : 0,
7029 "properties" : {
7030 "cf" : {
7031 "description" : "The RRD consolidation function",
7032 "enum" : [
7033 "AVERAGE",
7034 "MAX"
7035 ],
7036 "optional" : 1,
7037 "type" : "string"
7038 },
7039 "node" : {
7040 "description" : "The cluster node name.",
7041 "format" : "pve-node",
7042 "type" : "string",
7043 "typetext" : "<string>"
7044 },
7045 "timeframe" : {
7046 "description" : "Specify the time frame you are interested in.",
7047 "enum" : [
7048 "hour",
7049 "day",
7050 "week",
7051 "month",
7052 "year"
7053 ],
7054 "type" : "string"
7055 }
7056 }
7057 },
7058 "protected" : 1,
7059 "proxyto" : "node",
7060 "returns" : {
7061 "items" : {
7062 "properties" : {},
7063 "type" : "object"
7064 },
7065 "type" : "array"
7066 }
7067 }
7068 },
7069 "leaf" : 1,
7070 "path" : "/nodes/{node}/rrddata",
7071 "text" : "rrddata"
7072 },
7073 {
7074 "info" : {
7075 "GET" : {
7076 "description" : "Read system log",
7077 "method" : "GET",
7078 "name" : "syslog",
7079 "parameters" : {
7080 "additionalProperties" : 0,
7081 "properties" : {
7082 "limit" : {
7083 "minimum" : 0,
7084 "optional" : 1,
7085 "type" : "integer",
7086 "typetext" : "<integer> (0 - N)"
7087 },
7088 "node" : {
7089 "description" : "The cluster node name.",
7090 "format" : "pve-node",
7091 "type" : "string",
7092 "typetext" : "<string>"
7093 },
7094 "since" : {
7095 "description" : "Display all log since this date-time string.",
7096 "optional" : 1,
7097 "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$",
7098 "type" : "string"
7099 },
7100 "start" : {
7101 "minimum" : 0,
7102 "optional" : 1,
7103 "type" : "integer",
7104 "typetext" : "<integer> (0 - N)"
7105 },
7106 "until" : {
7107 "description" : "Display all log until this date-time string.",
7108 "optional" : 1,
7109 "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$",
7110 "type" : "string"
7111 }
7112 }
7113 },
7114 "protected" : 1,
7115 "proxyto" : "node",
7116 "returns" : {
7117 "items" : {
7118 "properties" : {
7119 "n" : {
7120 "description" : "Line number",
7121 "type" : "integer"
7122 },
7123 "t" : {
7124 "description" : "Line text",
7125 "type" : "string"
7126 }
7127 },
7128 "type" : "object"
7129 },
7130 "type" : "array"
7131 }
7132 }
7133 },
7134 "leaf" : 1,
7135 "path" : "/nodes/{node}/syslog",
7136 "text" : "syslog"
7137 },
7138 {
7139 "info" : {
7140 "POST" : {
7141 "description" : "Creates a VNC Shell proxy.",
7142 "method" : "POST",
7143 "name" : "vncshell",
7144 "parameters" : {
7145 "additionalProperties" : 0,
7146 "properties" : {
7147 "node" : {
7148 "description" : "The cluster node name.",
7149 "format" : "pve-node",
7150 "type" : "string",
7151 "typetext" : "<string>"
7152 },
7153 "websocket" : {
7154 "default" : 1,
7155 "description" : "use websocket instead of standard vnc.",
7156 "optional" : 1,
7157 "type" : "boolean",
7158 "typetext" : "<boolean>"
7159 }
7160 }
7161 },
7162 "protected" : 1,
7163 "returns" : {
7164 "additionalProperties" : 0,
7165 "properties" : {
7166 "port" : {
7167 "type" : "integer"
7168 },
7169 "ticket" : {
7170 "type" : "string"
7171 },
7172 "upid" : {
7173 "type" : "string"
7174 },
7175 "user" : {
7176 "type" : "string"
7177 }
7178 }
7179 }
7180 }
7181 },
7182 "leaf" : 1,
7183 "path" : "/nodes/{node}/vncshell",
7184 "text" : "vncshell"
7185 },
7186 {
7187 "info" : {
7188 "GET" : {
7189 "description" : "Opens a weksocket for VNC traffic.",
7190 "method" : "GET",
7191 "name" : "vncwebsocket",
7192 "parameters" : {
7193 "additionalProperties" : 0,
7194 "properties" : {
7195 "node" : {
7196 "description" : "The cluster node name.",
7197 "format" : "pve-node",
7198 "type" : "string",
7199 "typetext" : "<string>"
7200 },
7201 "port" : {
7202 "description" : "Port number returned by previous vncproxy call.",
7203 "maximum" : 5999,
7204 "minimum" : 5900,
7205 "type" : "integer",
7206 "typetext" : "<integer> (5900 - 5999)"
7207 },
7208 "vncticket" : {
7209 "description" : "Ticket from previous call to vncproxy.",
7210 "maxLength" : 512,
7211 "type" : "string",
7212 "typetext" : "<string>"
7213 }
7214 }
7215 },
7216 "returns" : {
7217 "properties" : {
7218 "port" : {
7219 "type" : "string"
7220 }
7221 },
7222 "type" : "object"
7223 }
7224 }
7225 },
7226 "leaf" : 1,
7227 "path" : "/nodes/{node}/vncwebsocket",
7228 "text" : "vncwebsocket"
7229 },
7230 {
7231 "info" : {
7232 "GET" : {
7233 "description" : "Read DNS settings.",
7234 "method" : "GET",
7235 "name" : "dns",
7236 "parameters" : {
7237 "additionalProperties" : 0,
7238 "properties" : {
7239 "node" : {
7240 "description" : "The cluster node name.",
7241 "format" : "pve-node",
7242 "type" : "string",
7243 "typetext" : "<string>"
7244 }
7245 }
7246 },
7247 "proxyto" : "node",
7248 "returns" : {
7249 "additionalProperties" : 0,
7250 "properties" : {
7251 "dns1" : {
7252 "description" : "First name server IP address.",
7253 "optional" : 1,
7254 "type" : "string"
7255 },
7256 "dns2" : {
7257 "description" : "Second name server IP address.",
7258 "optional" : 1,
7259 "type" : "string"
7260 },
7261 "dns3" : {
7262 "description" : "Third name server IP address.",
7263 "optional" : 1,
7264 "type" : "string"
7265 },
7266 "search" : {
7267 "description" : "Search domain for host-name lookup.",
7268 "optional" : 1,
7269 "type" : "string"
7270 }
7271 },
7272 "type" : "object"
7273 }
7274 },
7275 "PUT" : {
7276 "description" : "Write DNS settings.",
7277 "method" : "PUT",
7278 "name" : "update_dns",
7279 "parameters" : {
7280 "additionalProperties" : 0,
7281 "properties" : {
7282 "dns1" : {
7283 "description" : "First name server IP address.",
7284 "format" : "ip",
7285 "optional" : 1,
7286 "type" : "string",
7287 "typetext" : "<string>"
7288 },
7289 "dns2" : {
7290 "description" : "Second name server IP address.",
7291 "format" : "ip",
7292 "optional" : 1,
7293 "type" : "string",
7294 "typetext" : "<string>"
7295 },
7296 "dns3" : {
7297 "description" : "Third name server IP address.",
7298 "format" : "ip",
7299 "optional" : 1,
7300 "type" : "string",
7301 "typetext" : "<string>"
7302 },
7303 "node" : {
7304 "description" : "The cluster node name.",
7305 "format" : "pve-node",
7306 "type" : "string",
7307 "typetext" : "<string>"
7308 },
7309 "search" : {
7310 "description" : "Search domain for host-name lookup.",
7311 "type" : "string",
7312 "typetext" : "<string>"
7313 }
7314 }
7315 },
7316 "protected" : 1,
7317 "proxyto" : "node",
7318 "returns" : {
7319 "type" : "null"
7320 }
7321 }
7322 },
7323 "leaf" : 1,
7324 "path" : "/nodes/{node}/dns",
7325 "text" : "dns"
7326 },
7327 {
7328 "info" : {
7329 "GET" : {
7330 "description" : "Read server time and time zone settings.",
7331 "method" : "GET",
7332 "name" : "time",
7333 "parameters" : {
7334 "additionalProperties" : 0,
7335 "properties" : {
7336 "node" : {
7337 "description" : "The cluster node name.",
7338 "format" : "pve-node",
7339 "type" : "string",
7340 "typetext" : "<string>"
7341 }
7342 }
7343 },
7344 "proxyto" : "node",
7345 "returns" : {
7346 "additionalProperties" : 0,
7347 "properties" : {
7348 "localtime" : {
7349 "description" : "Seconds since 1970-01-01 00:00:00 (local time)",
7350 "minimum" : 1297163644,
7351 "type" : "integer"
7352 },
7353 "time" : {
7354 "description" : "Seconds since 1970-01-01 00:00:00 UTC.",
7355 "minimum" : 1297163644,
7356 "type" : "integer"
7357 },
7358 "timezone" : {
7359 "description" : "Time zone",
7360 "type" : "string"
7361 }
7362 },
7363 "type" : "object"
7364 }
7365 },
7366 "PUT" : {
7367 "description" : "Set time zone.",
7368 "method" : "PUT",
7369 "name" : "set_timezone",
7370 "parameters" : {
7371 "additionalProperties" : 0,
7372 "properties" : {
7373 "node" : {
7374 "description" : "The cluster node name.",
7375 "format" : "pve-node",
7376 "type" : "string",
7377 "typetext" : "<string>"
7378 },
7379 "timezone" : {
7380 "description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.",
7381 "type" : "string",
7382 "typetext" : "<string>"
7383 }
7384 }
7385 },
7386 "protected" : 1,
7387 "proxyto" : "node",
7388 "returns" : {
7389 "type" : "null"
7390 }
7391 }
7392 },
7393 "leaf" : 1,
7394 "path" : "/nodes/{node}/time",
7395 "text" : "time"
7396 }
7397 ],
7398 "info" : {
7399 "GET" : {
7400 "description" : "Node index.",
7401 "method" : "GET",
7402 "name" : "index",
7403 "parameters" : {
7404 "additionalProperties" : 0,
7405 "properties" : {
7406 "node" : {
7407 "description" : "The cluster node name.",
7408 "format" : "pve-node",
7409 "type" : "string",
7410 "typetext" : "<string>"
7411 }
7412 }
7413 },
7414 "permissions" : {
7415 "user" : "all"
7416 },
7417 "returns" : {
7418 "items" : {
7419 "properties" : {},
7420 "type" : "object"
7421 },
7422 "links" : [
7423 {
7424 "href" : "{name}",
7425 "rel" : "child"
7426 }
7427 ],
7428 "type" : "array"
7429 }
7430 }
7431 },
7432 "leaf" : 0,
7433 "path" : "/nodes/{node}",
7434 "text" : "{node}"
7435 }
7436 ],
7437 "info" : {
7438 "GET" : {
7439 "description" : "Cluster node index.",
7440 "method" : "GET",
7441 "name" : "index",
7442 "parameters" : {
7443 "additionalProperties" : 0
7444 },
7445 "permissions" : {
7446 "user" : "all"
7447 },
7448 "returns" : {
7449 "items" : {
7450 "properties" : {},
7451 "type" : "object"
7452 },
7453 "links" : [
7454 {
7455 "href" : "{node}",
7456 "rel" : "child"
7457 }
7458 ],
7459 "type" : "array"
7460 }
7461 }
7462 },
7463 "leaf" : 0,
7464 "path" : "/nodes",
7465 "text" : "nodes"
7466 },
7467 {
7468 "children" : [
7469 {
7470 "children" : [
7471 {
7472 "info" : {
7473 "DELETE" : {
7474 "description" : "Delete a user.",
7475 "method" : "DELETE",
7476 "name" : "delete",
7477 "parameters" : {
7478 "additionalProperties" : 0,
7479 "properties" : {
7480 "userid" : {
7481 "description" : "User ID",
7482 "format" : "pmg-userid",
7483 "maxLength" : 64,
7484 "minLength" : 4,
7485 "type" : "string",
7486 "typetext" : "<string>"
7487 }
7488 }
7489 },
7490 "protected" : 1,
7491 "proxyto" : "master",
7492 "returns" : {
7493 "type" : "null"
7494 }
7495 },
7496 "GET" : {
7497 "description" : "Read User data.",
7498 "method" : "GET",
7499 "name" : "read",
7500 "parameters" : {
7501 "additionalProperties" : 0,
7502 "properties" : {
7503 "userid" : {
7504 "description" : "User ID",
7505 "format" : "pmg-userid",
7506 "maxLength" : 64,
7507 "minLength" : 4,
7508 "type" : "string",
7509 "typetext" : "<string>"
7510 }
7511 }
7512 },
7513 "protected" : 1,
7514 "proxyto" : "master",
7515 "returns" : {
7516 "properties" : {},
7517 "type" : "object"
7518 }
7519 },
7520 "PUT" : {
7521 "description" : "Update user data.",
7522 "method" : "PUT",
7523 "name" : "write",
7524 "parameters" : {
7525 "additionalProperties" : 0,
7526 "properties" : {
7527 "comment" : {
7528 "description" : "Comment.",
7529 "optional" : 1,
7530 "type" : "string",
7531 "typetext" : "<string>"
7532 },
7533 "crypt_pass" : {
7534 "description" : "Encrypted password (see `man crypt`)",
7535 "optional" : 1,
7536 "pattern" : "\\$\\d\\$[a-zA-Z0-9\\.\\/]+\\$[a-zA-Z0-9\\.\\/]+",
7537 "type" : "string"
7538 },
7539 "delete" : {
7540 "description" : "A list of settings you want to delete.",
7541 "format" : "pve-configid-list",
7542 "maxLength" : 4096,
7543 "optional" : 1,
7544 "type" : "string",
7545 "typetext" : "<string>"
7546 },
7547 "email" : {
7548 "description" : "Users E-Mail address.",
7549 "format" : "email",
7550 "optional" : 1,
7551 "type" : "string",
7552 "typetext" : "<string>"
7553 },
7554 "enable" : {
7555 "default" : 0,
7556 "description" : "Flag to enable or disable the account.",
7557 "optional" : 1,
7558 "type" : "boolean",
7559 "typetext" : "<boolean>"
7560 },
7561 "expire" : {
7562 "default" : 0,
7563 "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
7564 "minimum" : 0,
7565 "optional" : 1,
7566 "type" : "integer",
7567 "typetext" : "<integer> (0 - N)"
7568 },
7569 "firstname" : {
7570 "description" : "First name.",
7571 "maxLength" : 64,
7572 "optional" : 1,
7573 "type" : "string",
7574 "typetext" : "<string>"
7575 },
7576 "keys" : {
7577 "description" : "Keys for two factor auth (yubico).",
7578 "maxLength" : 128,
7579 "optional" : 1,
7580 "type" : "string",
7581 "typetext" : "<string>"
7582 },
7583 "lastname" : {
7584 "description" : "Last name.",
7585 "maxLength" : 64,
7586 "optional" : 1,
7587 "type" : "string",
7588 "typetext" : "<string>"
7589 },
7590 "password" : {
7591 "description" : "Password",
7592 "maxLength" : 32,
7593 "minLength" : 5,
7594 "optional" : 1,
7595 "type" : "string",
7596 "typetext" : "<string>"
7597 },
7598 "role" : {
7599 "description" : "User role. Role 'root' is reseved for the Unix Superuser.",
7600 "enum" : [
7601 "root",
7602 "admin",
7603 "qmanager",
7604 "audit"
7605 ],
7606 "optional" : 1,
7607 "type" : "string"
7608 },
7609 "userid" : {
7610 "description" : "User ID",
7611 "format" : "pmg-userid",
7612 "maxLength" : 64,
7613 "minLength" : 4,
7614 "type" : "string",
7615 "typetext" : "<string>"
7616 }
7617 }
7618 },
7619 "protected" : 1,
7620 "proxyto" : "master",
7621 "returns" : {
7622 "type" : "null"
7623 }
7624 }
7625 },
7626 "leaf" : 1,
7627 "path" : "/access/users/{userid}",
7628 "text" : "{userid}"
7629 }
7630 ],
7631 "info" : {
7632 "GET" : {
7633 "description" : "List users.",
7634 "method" : "GET",
7635 "name" : "index",
7636 "parameters" : {
7637 "additionalProperties" : 0
7638 },
7639 "permissions" : {
7640 "check" : [
7641 "admin"
7642 ]
7643 },
7644 "protected" : 1,
7645 "proxyto" : "master",
7646 "returns" : {
7647 "items" : {
7648 "properties" : {
7649 "comment" : {
7650 "optional" : 1,
7651 "type" : "string"
7652 },
7653 "enable" : {
7654 "type" : "boolean"
7655 },
7656 "role" : {
7657 "type" : "string"
7658 },
7659 "userid" : {
7660 "type" : "string"
7661 }
7662 },
7663 "type" : "object"
7664 },
7665 "links" : [
7666 {
7667 "href" : "{userid}",
7668 "rel" : "child"
7669 }
7670 ],
7671 "type" : "array"
7672 }
7673 },
7674 "POST" : {
7675 "description" : "Creat new user",
7676 "method" : "POST",
7677 "name" : "create",
7678 "parameters" : {
7679 "additionalProperties" : 0,
7680 "properties" : {
7681 "comment" : {
7682 "description" : "Comment.",
7683 "optional" : 1,
7684 "type" : "string",
7685 "typetext" : "<string>"
7686 },
7687 "crypt_pass" : {
7688 "description" : "Encrypted password (see `man crypt`)",
7689 "optional" : 1,
7690 "pattern" : "\\$\\d\\$[a-zA-Z0-9\\.\\/]+\\$[a-zA-Z0-9\\.\\/]+",
7691 "type" : "string"
7692 },
7693 "email" : {
7694 "description" : "Users E-Mail address.",
7695 "format" : "email",
7696 "optional" : 1,
7697 "type" : "string",
7698 "typetext" : "<string>"
7699 },
7700 "enable" : {
7701 "default" : 0,
7702 "description" : "Flag to enable or disable the account.",
7703 "optional" : 1,
7704 "type" : "boolean",
7705 "typetext" : "<boolean>"
7706 },
7707 "expire" : {
7708 "default" : 0,
7709 "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
7710 "minimum" : 0,
7711 "optional" : 1,
7712 "type" : "integer",
7713 "typetext" : "<integer> (0 - N)"
7714 },
7715 "firstname" : {
7716 "description" : "First name.",
7717 "maxLength" : 64,
7718 "optional" : 1,
7719 "type" : "string",
7720 "typetext" : "<string>"
7721 },
7722 "keys" : {
7723 "description" : "Keys for two factor auth (yubico).",
7724 "maxLength" : 128,
7725 "optional" : 1,
7726 "type" : "string",
7727 "typetext" : "<string>"
7728 },
7729 "lastname" : {
7730 "description" : "Last name.",
7731 "maxLength" : 64,
7732 "optional" : 1,
7733 "type" : "string",
7734 "typetext" : "<string>"
7735 },
7736 "password" : {
7737 "description" : "Password",
7738 "maxLength" : 32,
7739 "minLength" : 5,
7740 "optional" : 1,
7741 "type" : "string",
7742 "typetext" : "<string>"
7743 },
7744 "role" : {
7745 "description" : "User role. Role 'root' is reseved for the Unix Superuser.",
7746 "enum" : [
7747 "root",
7748 "admin",
7749 "qmanager",
7750 "audit"
7751 ],
7752 "type" : "string"
7753 },
7754 "userid" : {
7755 "description" : "User ID",
7756 "format" : "pmg-userid",
7757 "maxLength" : 64,
7758 "minLength" : 4,
7759 "type" : "string",
7760 "typetext" : "<string>"
7761 }
7762 }
7763 },
7764 "protected" : 1,
7765 "proxyto" : "master",
7766 "returns" : {
7767 "type" : "null"
7768 }
7769 }
7770 },
7771 "leaf" : 0,
7772 "path" : "/access/users",
7773 "text" : "users"
7774 },
7775 {
7776 "info" : {
7777 "GET" : {
7778 "description" : "Dummy. Useful for formaters which want to priovde a login page.",
7779 "method" : "GET",
7780 "name" : "get_ticket",
7781 "parameters" : {
7782 "additionalProperties" : 0
7783 },
7784 "permissions" : {
7785 "user" : "world"
7786 },
7787 "returns" : {
7788 "type" : "null"
7789 }
7790 },
7791 "POST" : {
7792 "description" : "Create or verify authentication ticket.",
7793 "method" : "POST",
7794 "name" : "create_ticket",
7795 "parameters" : {
7796 "additionalProperties" : 0,
7797 "properties" : {
7798 "otp" : {
7799 "description" : "One-time password for Two-factor authentication.",
7800 "optional" : 1,
7801 "type" : "string",
7802 "typetext" : "<string>"
7803 },
7804 "password" : {
7805 "description" : "The secret password. This can also be a valid ticket.",
7806 "type" : "string",
7807 "typetext" : "<string>"
7808 },
7809 "realm" : {
7810 "description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.",
7811 "format" : "pmg-realm",
7812 "maxLength" : 32,
7813 "optional" : 1,
7814 "type" : "string",
7815 "typetext" : "<string>"
7816 },
7817 "username" : {
7818 "description" : "User name",
7819 "maxLength" : 64,
7820 "type" : "string",
7821 "typetext" : "<string>"
7822 }
7823 }
7824 },
7825 "permissions" : {
7826 "description" : "You need to pass valid credientials.",
7827 "user" : "world"
7828 },
7829 "protected" : 1,
7830 "returns" : {
7831 "properties" : {
7832 "CSRFPreventionToken" : {
7833 "optional" : 1,
7834 "type" : "string"
7835 },
7836 "role" : {
7837 "optional" : 1,
7838 "type" : "string"
7839 },
7840 "ticket" : {
7841 "optional" : 1,
7842 "type" : "string"
7843 },
7844 "username" : {
7845 "type" : "string"
7846 }
7847 },
7848 "type" : "object"
7849 }
7850 }
7851 },
7852 "leaf" : 1,
7853 "path" : "/access/ticket",
7854 "text" : "ticket"
7855 },
7856 {
7857 "info" : {
7858 "PUT" : {
7859 "description" : "Change user password.",
7860 "method" : "PUT",
7861 "name" : "change_passsword",
7862 "parameters" : {
7863 "additionalProperties" : 0,
7864 "properties" : {
7865 "password" : {
7866 "description" : "The new password.",
7867 "maxLength" : 64,
7868 "minLength" : 5,
7869 "type" : "string",
7870 "typetext" : "<string>"
7871 },
7872 "userid" : {
7873 "description" : "User ID",
7874 "format" : "pmg-userid",
7875 "maxLength" : 64,
7876 "minLength" : 4,
7877 "type" : "string",
7878 "typetext" : "<string>"
7879 }
7880 }
7881 },
7882 "permissions" : {
7883 "description" : "Each user is allowed to change his own password. Only root can change the password of another user.",
7884 "user" : "all"
7885 },
7886 "protected" : 1,
7887 "returns" : {
7888 "type" : "null"
7889 }
7890 }
7891 },
7892 "leaf" : 1,
7893 "path" : "/access/password",
7894 "text" : "password"
7895 }
7896 ],
7897 "info" : {
7898 "GET" : {
7899 "description" : "Directory index.",
7900 "method" : "GET",
7901 "name" : "index",
7902 "parameters" : {
7903 "additionalProperties" : 0
7904 },
7905 "permissions" : {
7906 "user" : "all"
7907 },
7908 "returns" : {
7909 "items" : {
7910 "properties" : {
7911 "subdir" : {
7912 "type" : "string"
7913 }
7914 },
7915 "type" : "object"
7916 },
7917 "links" : [
7918 {
7919 "href" : "{subdir}",
7920 "rel" : "child"
7921 }
7922 ],
7923 "type" : "array"
7924 }
7925 }
7926 },
7927 "leaf" : 0,
7928 "path" : "/access",
7929 "text" : "access"
7930 },
7931 {
7932 "info" : {
7933 "GET" : {
7934 "description" : "API version details.",
7935 "method" : "GET",
7936 "name" : "version",
7937 "parameters" : {
7938 "additionalProperties" : 0
7939 },
7940 "permissions" : {
7941 "user" : "all"
7942 },
7943 "returns" : {
7944 "properties" : {
7945 "release" : {
7946 "type" : "string"
7947 },
7948 "repoid" : {
7949 "type" : "string"
7950 },
7951 "version" : {
7952 "type" : "string"
7953 }
7954 },
7955 "type" : "object"
7956 }
7957 }
7958 },
7959 "leaf" : 1,
7960 "path" : "/version",
7961 "text" : "version"
7962 }
7963 ]
7964 ;
7965
PMG Documentation