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