]> git.proxmox.com Git - pmg-docs.git/blob - api-viewer/apidata.js
projects / pmg-docs.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
update static schema info
[pmg-docs.git] / api-viewer / apidata.js
1 var apiSchema = [
2 {
3 "children" : [
4 {
5 "children" : [
6 {
7 "info" : {
8 "GET" : {
9 "allowtoken" : 1,
10 "description" : "Returns the rule database digest. This is used internally for cluster synchronization.",
11 "method" : "GET",
12 "name" : "ruledb_digest",
13 "parameters" : {
14 "additionalProperties" : 0
15 },
16 "permissions" : {
17 "check" : [
18 "admin",
19 "audit"
20 ]
21 },
22 "returns" : {
23 "type" : "string"
24 }
25 }
26 },
27 "leaf" : 1,
28 "path" : "/config/ruledb/digest",
29 "text" : "digest"
30 },
31 {
32 "children" : [
33 {
34 "children" : [
35 {
36 "info" : {
37 "GET" : {
38 "allowtoken" : 1,
39 "description" : "Get common rule properties.",
40 "method" : "GET",
41 "name" : "config",
42 "parameters" : {
43 "additionalProperties" : 0,
44 "properties" : {
45 "id" : {
46 "description" : "Rule ID.",
47 "type" : "integer",
48 "typetext" : "<integer>"
49 }
50 }
51 },
52 "permissions" : {
53 "check" : [
54 "admin",
55 "audit"
56 ]
57 },
58 "proxyto" : "master",
59 "returns" : {
60 "properties" : {
61 "active" : {
62 "type" : "boolean"
63 },
64 "direction" : {
65 "type" : "integer"
66 },
67 "id" : {
68 "type" : "integer"
69 },
70 "name" : {
71 "type" : "string"
72 },
73 "priority" : {
74 "type" : "integer"
75 }
76 },
77 "type" : "object"
78 }
79 },
80 "PUT" : {
81 "allowtoken" : 1,
82 "description" : "Set rule properties.",
83 "method" : "PUT",
84 "name" : "update_config",
85 "parameters" : {
86 "additionalProperties" : 0,
87 "properties" : {
88 "active" : {
89 "description" : "Flag to activate rule.",
90 "optional" : 1,
91 "type" : "boolean",
92 "typetext" : "<boolean>"
93 },
94 "direction" : {
95 "description" : "Rule direction. Value `0` matches incoming mails, value `1` matches outgoing mails, and value `2` matches both directions.",
96 "maximum" : 2,
97 "minimum" : 0,
98 "optional" : 1,
99 "type" : "integer",
100 "typetext" : "<integer> (0 - 2)"
101 },
102 "id" : {
103 "description" : "Rule ID.",
104 "type" : "integer",
105 "typetext" : "<integer>"
106 },
107 "name" : {
108 "description" : "Rule name",
109 "optional" : 1,
110 "type" : "string",
111 "typetext" : "<string>"
112 },
113 "priority" : {
114 "description" : "Rule priotity.",
115 "maximum" : 100,
116 "minimum" : 0,
117 "optional" : 1,
118 "type" : "integer",
119 "typetext" : "<integer> (0 - 100)"
120 }
121 }
122 },
123 "permissions" : {
124 "check" : [
125 "admin"
126 ]
127 },
128 "protected" : 1,
129 "proxyto" : "master",
130 "returns" : {
131 "type" : "null"
132 }
133 }
134 },
135 "leaf" : 1,
136 "path" : "/config/ruledb/rules/{id}/config",
137 "text" : "config"
138 },
139 {
140 "children" : [
141 {
142 "info" : {
143 "DELETE" : {
144 "allowtoken" : 1,
145 "description" : "Delete group from 'from' list.",
146 "method" : "DELETE",
147 "name" : "delete_from_group",
148 "parameters" : {
149 "additionalProperties" : 0,
150 "properties" : {
151 "id" : {
152 "description" : "Rule ID.",
153 "type" : "integer",
154 "typetext" : "<integer>"
155 },
156 "ogroup" : {
157 "description" : "Groups ID.",
158 "type" : "integer",
159 "typetext" : "<integer>"
160 }
161 }
162 },
163 "permissions" : {
164 "check" : [
165 "admin"
166 ]
167 },
168 "protected" : 1,
169 "proxyto" : "master",
170 "returns" : {
171 "type" : "null"
172 }
173 }
174 },
175 "leaf" : 1,
176 "path" : "/config/ruledb/rules/{id}/from/{ogroup}",
177 "text" : "{ogroup}"
178 }
179 ],
180 "info" : {
181 "GET" : {
182 "allowtoken" : 1,
183 "description" : "Get 'from' group list.",
184 "method" : "GET",
185 "name" : "from",
186 "parameters" : {
187 "additionalProperties" : 0,
188 "properties" : {
189 "id" : {
190 "description" : "Rule ID.",
191 "type" : "integer",
192 "typetext" : "<integer>"
193 }
194 }
195 },
196 "permissions" : {
197 "check" : [
198 "admin",
199 "audit"
200 ]
201 },
202 "proxyto" : "master",
203 "returns" : {
204 "items" : {
205 "properties" : {
206 "id" : {
207 "type" : "integer"
208 }
209 },
210 "type" : "object"
211 },
212 "type" : "array"
213 }
214 },
215 "POST" : {
216 "allowtoken" : 1,
217 "description" : "Add group to 'from' list.",
218 "method" : "POST",
219 "name" : "add_from_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 "permissions" : {
236 "check" : [
237 "admin"
238 ]
239 },
240 "protected" : 1,
241 "proxyto" : "master",
242 "returns" : {
243 "type" : "null"
244 }
245 }
246 },
247 "leaf" : 0,
248 "path" : "/config/ruledb/rules/{id}/from",
249 "text" : "from"
250 },
251 {
252 "children" : [
253 {
254 "info" : {
255 "DELETE" : {
256 "allowtoken" : 1,
257 "description" : "Delete group from 'to' list.",
258 "method" : "DELETE",
259 "name" : "delete_to_group",
260 "parameters" : {
261 "additionalProperties" : 0,
262 "properties" : {
263 "id" : {
264 "description" : "Rule ID.",
265 "type" : "integer",
266 "typetext" : "<integer>"
267 },
268 "ogroup" : {
269 "description" : "Groups ID.",
270 "type" : "integer",
271 "typetext" : "<integer>"
272 }
273 }
274 },
275 "permissions" : {
276 "check" : [
277 "admin"
278 ]
279 },
280 "protected" : 1,
281 "proxyto" : "master",
282 "returns" : {
283 "type" : "null"
284 }
285 }
286 },
287 "leaf" : 1,
288 "path" : "/config/ruledb/rules/{id}/to/{ogroup}",
289 "text" : "{ogroup}"
290 }
291 ],
292 "info" : {
293 "GET" : {
294 "allowtoken" : 1,
295 "description" : "Get 'to' group list.",
296 "method" : "GET",
297 "name" : "to",
298 "parameters" : {
299 "additionalProperties" : 0,
300 "properties" : {
301 "id" : {
302 "description" : "Rule ID.",
303 "type" : "integer",
304 "typetext" : "<integer>"
305 }
306 }
307 },
308 "permissions" : {
309 "check" : [
310 "admin",
311 "audit"
312 ]
313 },
314 "proxyto" : "master",
315 "returns" : {
316 "items" : {
317 "properties" : {
318 "id" : {
319 "type" : "integer"
320 }
321 },
322 "type" : "object"
323 },
324 "type" : "array"
325 }
326 },
327 "POST" : {
328 "allowtoken" : 1,
329 "description" : "Add group to 'to' list.",
330 "method" : "POST",
331 "name" : "add_to_group",
332 "parameters" : {
333 "additionalProperties" : 0,
334 "properties" : {
335 "id" : {
336 "description" : "Rule ID.",
337 "type" : "integer",
338 "typetext" : "<integer>"
339 },
340 "ogroup" : {
341 "description" : "Groups ID.",
342 "type" : "integer",
343 "typetext" : "<integer>"
344 }
345 }
346 },
347 "permissions" : {
348 "check" : [
349 "admin"
350 ]
351 },
352 "protected" : 1,
353 "proxyto" : "master",
354 "returns" : {
355 "type" : "null"
356 }
357 }
358 },
359 "leaf" : 0,
360 "path" : "/config/ruledb/rules/{id}/to",
361 "text" : "to"
362 },
363 {
364 "children" : [
365 {
366 "info" : {
367 "DELETE" : {
368 "allowtoken" : 1,
369 "description" : "Delete group from 'when' list.",
370 "method" : "DELETE",
371 "name" : "delete_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 "permissions" : {
388 "check" : [
389 "admin"
390 ]
391 },
392 "protected" : 1,
393 "proxyto" : "master",
394 "returns" : {
395 "type" : "null"
396 }
397 }
398 },
399 "leaf" : 1,
400 "path" : "/config/ruledb/rules/{id}/when/{ogroup}",
401 "text" : "{ogroup}"
402 }
403 ],
404 "info" : {
405 "GET" : {
406 "allowtoken" : 1,
407 "description" : "Get 'when' group list.",
408 "method" : "GET",
409 "name" : "when",
410 "parameters" : {
411 "additionalProperties" : 0,
412 "properties" : {
413 "id" : {
414 "description" : "Rule ID.",
415 "type" : "integer",
416 "typetext" : "<integer>"
417 }
418 }
419 },
420 "permissions" : {
421 "check" : [
422 "admin",
423 "audit"
424 ]
425 },
426 "proxyto" : "master",
427 "returns" : {
428 "items" : {
429 "properties" : {
430 "id" : {
431 "type" : "integer"
432 }
433 },
434 "type" : "object"
435 },
436 "type" : "array"
437 }
438 },
439 "POST" : {
440 "allowtoken" : 1,
441 "description" : "Add group to 'when' list.",
442 "method" : "POST",
443 "name" : "add_when_group",
444 "parameters" : {
445 "additionalProperties" : 0,
446 "properties" : {
447 "id" : {
448 "description" : "Rule ID.",
449 "type" : "integer",
450 "typetext" : "<integer>"
451 },
452 "ogroup" : {
453 "description" : "Groups ID.",
454 "type" : "integer",
455 "typetext" : "<integer>"
456 }
457 }
458 },
459 "permissions" : {
460 "check" : [
461 "admin"
462 ]
463 },
464 "protected" : 1,
465 "proxyto" : "master",
466 "returns" : {
467 "type" : "null"
468 }
469 }
470 },
471 "leaf" : 0,
472 "path" : "/config/ruledb/rules/{id}/when",
473 "text" : "when"
474 },
475 {
476 "children" : [
477 {
478 "info" : {
479 "DELETE" : {
480 "allowtoken" : 1,
481 "description" : "Delete group from 'what' list.",
482 "method" : "DELETE",
483 "name" : "delete_what_group",
484 "parameters" : {
485 "additionalProperties" : 0,
486 "properties" : {
487 "id" : {
488 "description" : "Rule ID.",
489 "type" : "integer",
490 "typetext" : "<integer>"
491 },
492 "ogroup" : {
493 "description" : "Groups ID.",
494 "type" : "integer",
495 "typetext" : "<integer>"
496 }
497 }
498 },
499 "permissions" : {
500 "check" : [
501 "admin"
502 ]
503 },
504 "protected" : 1,
505 "proxyto" : "master",
506 "returns" : {
507 "type" : "null"
508 }
509 }
510 },
511 "leaf" : 1,
512 "path" : "/config/ruledb/rules/{id}/what/{ogroup}",
513 "text" : "{ogroup}"
514 }
515 ],
516 "info" : {
517 "GET" : {
518 "allowtoken" : 1,
519 "description" : "Get 'what' group list.",
520 "method" : "GET",
521 "name" : "what",
522 "parameters" : {
523 "additionalProperties" : 0,
524 "properties" : {
525 "id" : {
526 "description" : "Rule ID.",
527 "type" : "integer",
528 "typetext" : "<integer>"
529 }
530 }
531 },
532 "permissions" : {
533 "check" : [
534 "admin",
535 "audit"
536 ]
537 },
538 "proxyto" : "master",
539 "returns" : {
540 "items" : {
541 "properties" : {
542 "id" : {
543 "type" : "integer"
544 }
545 },
546 "type" : "object"
547 },
548 "type" : "array"
549 }
550 },
551 "POST" : {
552 "allowtoken" : 1,
553 "description" : "Add group to 'what' list.",
554 "method" : "POST",
555 "name" : "add_what_group",
556 "parameters" : {
557 "additionalProperties" : 0,
558 "properties" : {
559 "id" : {
560 "description" : "Rule ID.",
561 "type" : "integer",
562 "typetext" : "<integer>"
563 },
564 "ogroup" : {
565 "description" : "Groups ID.",
566 "type" : "integer",
567 "typetext" : "<integer>"
568 }
569 }
570 },
571 "permissions" : {
572 "check" : [
573 "admin"
574 ]
575 },
576 "protected" : 1,
577 "proxyto" : "master",
578 "returns" : {
579 "type" : "null"
580 }
581 }
582 },
583 "leaf" : 0,
584 "path" : "/config/ruledb/rules/{id}/what",
585 "text" : "what"
586 },
587 {
588 "children" : [
589 {
590 "info" : {
591 "DELETE" : {
592 "allowtoken" : 1,
593 "description" : "Delete group from 'action' list.",
594 "method" : "DELETE",
595 "name" : "delete_action_group",
596 "parameters" : {
597 "additionalProperties" : 0,
598 "properties" : {
599 "id" : {
600 "description" : "Rule ID.",
601 "type" : "integer",
602 "typetext" : "<integer>"
603 },
604 "ogroup" : {
605 "description" : "Groups ID.",
606 "type" : "integer",
607 "typetext" : "<integer>"
608 }
609 }
610 },
611 "permissions" : {
612 "check" : [
613 "admin"
614 ]
615 },
616 "protected" : 1,
617 "proxyto" : "master",
618 "returns" : {
619 "type" : "null"
620 }
621 }
622 },
623 "leaf" : 1,
624 "path" : "/config/ruledb/rules/{id}/action/{ogroup}",
625 "text" : "{ogroup}"
626 }
627 ],
628 "info" : {
629 "GET" : {
630 "allowtoken" : 1,
631 "description" : "Get 'action' group list.",
632 "method" : "GET",
633 "name" : "action",
634 "parameters" : {
635 "additionalProperties" : 0,
636 "properties" : {
637 "id" : {
638 "description" : "Rule ID.",
639 "type" : "integer",
640 "typetext" : "<integer>"
641 }
642 }
643 },
644 "permissions" : {
645 "check" : [
646 "admin",
647 "audit"
648 ]
649 },
650 "proxyto" : "master",
651 "returns" : {
652 "items" : {
653 "properties" : {
654 "id" : {
655 "type" : "integer"
656 }
657 },
658 "type" : "object"
659 },
660 "type" : "array"
661 }
662 },
663 "POST" : {
664 "allowtoken" : 1,
665 "description" : "Add group to 'action' list.",
666 "method" : "POST",
667 "name" : "add_action_group",
668 "parameters" : {
669 "additionalProperties" : 0,
670 "properties" : {
671 "id" : {
672 "description" : "Rule ID.",
673 "type" : "integer",
674 "typetext" : "<integer>"
675 },
676 "ogroup" : {
677 "description" : "Groups ID.",
678 "type" : "integer",
679 "typetext" : "<integer>"
680 }
681 }
682 },
683 "permissions" : {
684 "check" : [
685 "admin"
686 ]
687 },
688 "protected" : 1,
689 "proxyto" : "master",
690 "returns" : {
691 "type" : "null"
692 }
693 }
694 },
695 "leaf" : 0,
696 "path" : "/config/ruledb/rules/{id}/action",
697 "text" : "action"
698 }
699 ],
700 "info" : {
701 "DELETE" : {
702 "allowtoken" : 1,
703 "description" : "Delete rule.",
704 "method" : "DELETE",
705 "name" : "delete_rule",
706 "parameters" : {
707 "additionalProperties" : 0,
708 "properties" : {
709 "id" : {
710 "description" : "Rule ID.",
711 "type" : "integer",
712 "typetext" : "<integer>"
713 }
714 }
715 },
716 "permissions" : {
717 "check" : [
718 "admin"
719 ]
720 },
721 "protected" : 1,
722 "proxyto" : "master",
723 "returns" : {
724 "type" : "null"
725 }
726 },
727 "GET" : {
728 "allowtoken" : 1,
729 "description" : "Directory index.",
730 "method" : "GET",
731 "name" : "index",
732 "parameters" : {
733 "additionalProperties" : 0,
734 "properties" : {
735 "id" : {
736 "description" : "Rule ID.",
737 "type" : "integer",
738 "typetext" : "<integer>"
739 }
740 }
741 },
742 "permissions" : {
743 "check" : [
744 "admin",
745 "audit"
746 ]
747 },
748 "returns" : {
749 "items" : {
750 "properties" : {
751 "subdir" : {
752 "type" : "string"
753 }
754 },
755 "type" : "object"
756 },
757 "links" : [
758 {
759 "href" : "{subdir}",
760 "rel" : "child"
761 }
762 ],
763 "type" : "array"
764 }
765 }
766 },
767 "leaf" : 0,
768 "path" : "/config/ruledb/rules/{id}",
769 "text" : "{id}"
770 }
771 ],
772 "info" : {
773 "GET" : {
774 "allowtoken" : 1,
775 "description" : "Get list of rules.",
776 "method" : "GET",
777 "name" : "list_rules",
778 "parameters" : {
779 "additionalProperties" : 0
780 },
781 "permissions" : {
782 "check" : [
783 "admin",
784 "audit"
785 ]
786 },
787 "proxyto" : "master",
788 "returns" : {
789 "items" : {
790 "properties" : {
791 "id" : {
792 "type" : "integer"
793 }
794 },
795 "type" : "object"
796 },
797 "links" : [
798 {
799 "href" : "{id}",
800 "rel" : "child"
801 }
802 ],
803 "type" : "array"
804 }
805 },
806 "POST" : {
807 "allowtoken" : 1,
808 "description" : "Create new rule.",
809 "method" : "POST",
810 "name" : "create_rule",
811 "parameters" : {
812 "additionalProperties" : 0,
813 "properties" : {
814 "active" : {
815 "description" : "Flag to activate rule.",
816 "optional" : 1,
817 "type" : "boolean",
818 "typetext" : "<boolean>"
819 },
820 "direction" : {
821 "description" : "Rule direction. Value `0` matches incoming mails, value `1` matches outgoing mails, and value `2` matches both directions.",
822 "maximum" : 2,
823 "minimum" : 0,
824 "optional" : 1,
825 "type" : "integer",
826 "typetext" : "<integer> (0 - 2)"
827 },
828 "name" : {
829 "description" : "Rule name",
830 "type" : "string",
831 "typetext" : "<string>"
832 },
833 "priority" : {
834 "description" : "Rule priotity.",
835 "maximum" : 100,
836 "minimum" : 0,
837 "type" : "integer",
838 "typetext" : "<integer> (0 - 100)"
839 }
840 }
841 },
842 "permissions" : {
843 "check" : [
844 "admin"
845 ]
846 },
847 "protected" : 1,
848 "proxyto" : "master",
849 "returns" : {
850 "type" : "integer"
851 }
852 }
853 },
854 "leaf" : 0,
855 "path" : "/config/ruledb/rules",
856 "text" : "rules"
857 },
858 {
859 "children" : [
860 {
861 "children" : [
862 {
863 "info" : {
864 "DELETE" : {
865 "allowtoken" : 1,
866 "description" : "Delete 'actions' object.",
867 "method" : "DELETE",
868 "name" : "delete_action",
869 "parameters" : {
870 "additionalProperties" : 0,
871 "properties" : {
872 "id" : {
873 "description" : "Action Object ID.",
874 "pattern" : "\\d+_\\d+",
875 "type" : "string"
876 }
877 }
878 },
879 "permissions" : {
880 "check" : [
881 "admin"
882 ]
883 },
884 "protected" : 1,
885 "proxyto" : "master",
886 "returns" : {
887 "type" : "null"
888 }
889 }
890 },
891 "leaf" : 1,
892 "path" : "/config/ruledb/action/objects/{id}",
893 "text" : "{id}"
894 }
895 ],
896 "info" : {
897 "GET" : {
898 "allowtoken" : 1,
899 "description" : "List 'actions' objects.",
900 "method" : "GET",
901 "name" : "list_actions",
902 "parameters" : {
903 "additionalProperties" : 0
904 },
905 "permissions" : {
906 "check" : [
907 "admin",
908 "audit"
909 ]
910 },
911 "proxyto" : "master",
912 "returns" : {
913 "items" : {
914 "properties" : {
915 "id" : {
916 "description" : "Action Object ID.",
917 "pattern" : "\\d+_\\d+",
918 "type" : "string"
919 }
920 },
921 "type" : "object"
922 },
923 "links" : [
924 {
925 "href" : "{id}",
926 "rel" : "child"
927 }
928 ],
929 "type" : "array"
930 }
931 }
932 },
933 "leaf" : 0,
934 "path" : "/config/ruledb/action/objects",
935 "text" : "objects"
936 },
937 {
938 "children" : [
939 {
940 "info" : {
941 "GET" : {
942 "allowtoken" : 1,
943 "description" : "Read 'BCC' object settings.",
944 "method" : "GET",
945 "name" : "read_bcc",
946 "parameters" : {
947 "additionalProperties" : 0,
948 "properties" : {
949 "id" : {
950 "description" : "Action Object ID.",
951 "pattern" : "\\d+_\\d+",
952 "type" : "string"
953 }
954 }
955 },
956 "permissions" : {
957 "check" : [
958 "admin",
959 "audit"
960 ]
961 },
962 "proxyto" : "master",
963 "returns" : {
964 "properties" : {
965 "id" : {
966 "type" : "string"
967 }
968 },
969 "type" : "object"
970 }
971 },
972 "PUT" : {
973 "allowtoken" : 1,
974 "description" : "Update 'BCC' object.",
975 "method" : "PUT",
976 "name" : "update_bcc",
977 "parameters" : {
978 "additionalProperties" : 0,
979 "properties" : {
980 "id" : {
981 "description" : "Action Object ID.",
982 "pattern" : "\\d+_\\d+",
983 "type" : "string"
984 },
985 "info" : {
986 "description" : "Informational comment.",
987 "maxLength" : 255,
988 "optional" : 1,
989 "type" : "string",
990 "typetext" : "<string>"
991 },
992 "name" : {
993 "description" : "Action name.",
994 "maxLength" : 255,
995 "optional" : 1,
996 "type" : "string",
997 "typetext" : "<string>"
998 },
999 "original" : {
1000 "default" : 1,
1001 "description" : "Send the original, unmodified mail.",
1002 "optional" : 1,
1003 "type" : "boolean",
1004 "typetext" : "<boolean>"
1005 },
1006 "target" : {
1007 "description" : "Send a Blind Carbon Copy to this email address.",
1008 "format" : "email",
1009 "type" : "string",
1010 "typetext" : "<string>"
1011 }
1012 }
1013 },
1014 "permissions" : {
1015 "check" : [
1016 "admin"
1017 ]
1018 },
1019 "protected" : 1,
1020 "proxyto" : "master",
1021 "returns" : {
1022 "type" : "null"
1023 }
1024 }
1025 },
1026 "leaf" : 1,
1027 "path" : "/config/ruledb/action/bcc/{id}",
1028 "text" : "{id}"
1029 }
1030 ],
1031 "info" : {
1032 "POST" : {
1033 "allowtoken" : 1,
1034 "description" : "Create 'BCC' object.",
1035 "method" : "POST",
1036 "name" : "bcc",
1037 "parameters" : {
1038 "additionalProperties" : 0,
1039 "properties" : {
1040 "info" : {
1041 "description" : "Informational comment.",
1042 "maxLength" : 255,
1043 "optional" : 1,
1044 "type" : "string",
1045 "typetext" : "<string>"
1046 },
1047 "name" : {
1048 "description" : "Action name.",
1049 "maxLength" : 255,
1050 "type" : "string",
1051 "typetext" : "<string>"
1052 },
1053 "original" : {
1054 "default" : 1,
1055 "description" : "Send the original, unmodified mail.",
1056 "optional" : 1,
1057 "type" : "boolean",
1058 "typetext" : "<boolean>"
1059 },
1060 "target" : {
1061 "description" : "Send a Blind Carbon Copy to this email address.",
1062 "format" : "email",
1063 "type" : "string",
1064 "typetext" : "<string>"
1065 }
1066 }
1067 },
1068 "permissions" : {
1069 "check" : [
1070 "admin"
1071 ]
1072 },
1073 "protected" : 1,
1074 "proxyto" : "master",
1075 "returns" : {
1076 "description" : "The object ID.",
1077 "type" : "string"
1078 }
1079 }
1080 },
1081 "leaf" : 0,
1082 "path" : "/config/ruledb/action/bcc",
1083 "text" : "bcc"
1084 },
1085 {
1086 "children" : [
1087 {
1088 "info" : {
1089 "GET" : {
1090 "allowtoken" : 1,
1091 "description" : "Read 'Header Attribute' object settings.",
1092 "method" : "GET",
1093 "name" : "read_field",
1094 "parameters" : {
1095 "additionalProperties" : 0,
1096 "properties" : {
1097 "id" : {
1098 "description" : "Action Object ID.",
1099 "pattern" : "\\d+_\\d+",
1100 "type" : "string"
1101 }
1102 }
1103 },
1104 "permissions" : {
1105 "check" : [
1106 "admin",
1107 "audit"
1108 ]
1109 },
1110 "proxyto" : "master",
1111 "returns" : {
1112 "properties" : {
1113 "id" : {
1114 "type" : "string"
1115 }
1116 },
1117 "type" : "object"
1118 }
1119 },
1120 "PUT" : {
1121 "allowtoken" : 1,
1122 "description" : "Update 'Header Attribute' object.",
1123 "method" : "PUT",
1124 "name" : "update_field",
1125 "parameters" : {
1126 "additionalProperties" : 0,
1127 "properties" : {
1128 "field" : {
1129 "description" : "The Field",
1130 "maxLength" : 1024,
1131 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
1132 "type" : "string"
1133 },
1134 "id" : {
1135 "description" : "Action Object ID.",
1136 "pattern" : "\\d+_\\d+",
1137 "type" : "string"
1138 },
1139 "info" : {
1140 "description" : "Informational comment.",
1141 "maxLength" : 255,
1142 "optional" : 1,
1143 "type" : "string",
1144 "typetext" : "<string>"
1145 },
1146 "name" : {
1147 "description" : "Action name.",
1148 "maxLength" : 255,
1149 "optional" : 1,
1150 "type" : "string",
1151 "typetext" : "<string>"
1152 },
1153 "value" : {
1154 "description" : "The Value",
1155 "maxLength" : 1024,
1156 "type" : "string",
1157 "typetext" : "<string>"
1158 }
1159 }
1160 },
1161 "permissions" : {
1162 "check" : [
1163 "admin"
1164 ]
1165 },
1166 "protected" : 1,
1167 "proxyto" : "master",
1168 "returns" : {
1169 "type" : "null"
1170 }
1171 }
1172 },
1173 "leaf" : 1,
1174 "path" : "/config/ruledb/action/field/{id}",
1175 "text" : "{id}"
1176 }
1177 ],
1178 "info" : {
1179 "POST" : {
1180 "allowtoken" : 1,
1181 "description" : "Create 'Header Attribute' object.",
1182 "method" : "POST",
1183 "name" : "field",
1184 "parameters" : {
1185 "additionalProperties" : 0,
1186 "properties" : {
1187 "field" : {
1188 "description" : "The Field",
1189 "maxLength" : 1024,
1190 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
1191 "type" : "string"
1192 },
1193 "info" : {
1194 "description" : "Informational comment.",
1195 "maxLength" : 255,
1196 "optional" : 1,
1197 "type" : "string",
1198 "typetext" : "<string>"
1199 },
1200 "name" : {
1201 "description" : "Action name.",
1202 "maxLength" : 255,
1203 "type" : "string",
1204 "typetext" : "<string>"
1205 },
1206 "value" : {
1207 "description" : "The Value",
1208 "maxLength" : 1024,
1209 "type" : "string",
1210 "typetext" : "<string>"
1211 }
1212 }
1213 },
1214 "permissions" : {
1215 "check" : [
1216 "admin"
1217 ]
1218 },
1219 "protected" : 1,
1220 "proxyto" : "master",
1221 "returns" : {
1222 "description" : "The object ID.",
1223 "type" : "string"
1224 }
1225 }
1226 },
1227 "leaf" : 0,
1228 "path" : "/config/ruledb/action/field",
1229 "text" : "field"
1230 },
1231 {
1232 "children" : [
1233 {
1234 "info" : {
1235 "GET" : {
1236 "allowtoken" : 1,
1237 "description" : "Read 'Notification' object settings.",
1238 "method" : "GET",
1239 "name" : "read_notification",
1240 "parameters" : {
1241 "additionalProperties" : 0,
1242 "properties" : {
1243 "id" : {
1244 "description" : "Action Object ID.",
1245 "pattern" : "\\d+_\\d+",
1246 "type" : "string"
1247 }
1248 }
1249 },
1250 "permissions" : {
1251 "check" : [
1252 "admin",
1253 "audit"
1254 ]
1255 },
1256 "proxyto" : "master",
1257 "returns" : {
1258 "properties" : {
1259 "id" : {
1260 "type" : "string"
1261 }
1262 },
1263 "type" : "object"
1264 }
1265 },
1266 "PUT" : {
1267 "allowtoken" : 1,
1268 "description" : "Update 'Notification' object.",
1269 "method" : "PUT",
1270 "name" : "update_notification",
1271 "parameters" : {
1272 "additionalProperties" : 0,
1273 "properties" : {
1274 "attach" : {
1275 "default" : 0,
1276 "description" : "Attach original E-Mail",
1277 "optional" : 1,
1278 "type" : "boolean",
1279 "typetext" : "<boolean>"
1280 },
1281 "body" : {
1282 "description" : "The Notification Body",
1283 "maxLength" : 2048,
1284 "type" : "string",
1285 "typetext" : "<string>"
1286 },
1287 "id" : {
1288 "description" : "Action Object ID.",
1289 "pattern" : "\\d+_\\d+",
1290 "type" : "string"
1291 },
1292 "info" : {
1293 "description" : "Informational comment.",
1294 "maxLength" : 255,
1295 "optional" : 1,
1296 "type" : "string",
1297 "typetext" : "<string>"
1298 },
1299 "name" : {
1300 "description" : "Action name.",
1301 "maxLength" : 255,
1302 "optional" : 1,
1303 "type" : "string",
1304 "typetext" : "<string>"
1305 },
1306 "subject" : {
1307 "description" : "The Notification subject",
1308 "maxLength" : 100,
1309 "type" : "string",
1310 "typetext" : "<string>"
1311 },
1312 "to" : {
1313 "description" : "The Receiver E-Mail address",
1314 "maxLength" : 200,
1315 "type" : "string",
1316 "typetext" : "<string>"
1317 }
1318 }
1319 },
1320 "permissions" : {
1321 "check" : [
1322 "admin"
1323 ]
1324 },
1325 "protected" : 1,
1326 "proxyto" : "master",
1327 "returns" : {
1328 "type" : "null"
1329 }
1330 }
1331 },
1332 "leaf" : 1,
1333 "path" : "/config/ruledb/action/notification/{id}",
1334 "text" : "{id}"
1335 }
1336 ],
1337 "info" : {
1338 "POST" : {
1339 "allowtoken" : 1,
1340 "description" : "Create 'Notification' object.",
1341 "method" : "POST",
1342 "name" : "notification",
1343 "parameters" : {
1344 "additionalProperties" : 0,
1345 "properties" : {
1346 "attach" : {
1347 "default" : 0,
1348 "description" : "Attach original E-Mail",
1349 "optional" : 1,
1350 "type" : "boolean",
1351 "typetext" : "<boolean>"
1352 },
1353 "body" : {
1354 "description" : "The Notification Body",
1355 "maxLength" : 2048,
1356 "type" : "string",
1357 "typetext" : "<string>"
1358 },
1359 "info" : {
1360 "description" : "Informational comment.",
1361 "maxLength" : 255,
1362 "optional" : 1,
1363 "type" : "string",
1364 "typetext" : "<string>"
1365 },
1366 "name" : {
1367 "description" : "Action name.",
1368 "maxLength" : 255,
1369 "type" : "string",
1370 "typetext" : "<string>"
1371 },
1372 "subject" : {
1373 "description" : "The Notification subject",
1374 "maxLength" : 100,
1375 "type" : "string",
1376 "typetext" : "<string>"
1377 },
1378 "to" : {
1379 "description" : "The Receiver E-Mail address",
1380 "maxLength" : 200,
1381 "type" : "string",
1382 "typetext" : "<string>"
1383 }
1384 }
1385 },
1386 "permissions" : {
1387 "check" : [
1388 "admin"
1389 ]
1390 },
1391 "protected" : 1,
1392 "proxyto" : "master",
1393 "returns" : {
1394 "description" : "The object ID.",
1395 "type" : "string"
1396 }
1397 }
1398 },
1399 "leaf" : 0,
1400 "path" : "/config/ruledb/action/notification",
1401 "text" : "notification"
1402 },
1403 {
1404 "children" : [
1405 {
1406 "info" : {
1407 "GET" : {
1408 "allowtoken" : 1,
1409 "description" : "Read 'Disclaimer' object settings.",
1410 "method" : "GET",
1411 "name" : "read_disclaimer",
1412 "parameters" : {
1413 "additionalProperties" : 0,
1414 "properties" : {
1415 "id" : {
1416 "description" : "Action Object ID.",
1417 "pattern" : "\\d+_\\d+",
1418 "type" : "string"
1419 }
1420 }
1421 },
1422 "permissions" : {
1423 "check" : [
1424 "admin",
1425 "audit"
1426 ]
1427 },
1428 "proxyto" : "master",
1429 "returns" : {
1430 "properties" : {
1431 "id" : {
1432 "type" : "string"
1433 }
1434 },
1435 "type" : "object"
1436 }
1437 },
1438 "PUT" : {
1439 "allowtoken" : 1,
1440 "description" : "Update 'Disclaimer' object.",
1441 "method" : "PUT",
1442 "name" : "update_disclaimer",
1443 "parameters" : {
1444 "additionalProperties" : 0,
1445 "properties" : {
1446 "disclaimer" : {
1447 "description" : "The Disclaimer",
1448 "maxLength" : 2048,
1449 "type" : "string",
1450 "typetext" : "<string>"
1451 },
1452 "id" : {
1453 "description" : "Action Object ID.",
1454 "pattern" : "\\d+_\\d+",
1455 "type" : "string"
1456 },
1457 "info" : {
1458 "description" : "Informational comment.",
1459 "maxLength" : 255,
1460 "optional" : 1,
1461 "type" : "string",
1462 "typetext" : "<string>"
1463 },
1464 "name" : {
1465 "description" : "Action name.",
1466 "maxLength" : 255,
1467 "optional" : 1,
1468 "type" : "string",
1469 "typetext" : "<string>"
1470 }
1471 }
1472 },
1473 "permissions" : {
1474 "check" : [
1475 "admin"
1476 ]
1477 },
1478 "protected" : 1,
1479 "proxyto" : "master",
1480 "returns" : {
1481 "type" : "null"
1482 }
1483 }
1484 },
1485 "leaf" : 1,
1486 "path" : "/config/ruledb/action/disclaimer/{id}",
1487 "text" : "{id}"
1488 }
1489 ],
1490 "info" : {
1491 "POST" : {
1492 "allowtoken" : 1,
1493 "description" : "Create 'Disclaimer' object.",
1494 "method" : "POST",
1495 "name" : "disclaimer",
1496 "parameters" : {
1497 "additionalProperties" : 0,
1498 "properties" : {
1499 "disclaimer" : {
1500 "description" : "The Disclaimer",
1501 "maxLength" : 2048,
1502 "type" : "string",
1503 "typetext" : "<string>"
1504 },
1505 "info" : {
1506 "description" : "Informational comment.",
1507 "maxLength" : 255,
1508 "optional" : 1,
1509 "type" : "string",
1510 "typetext" : "<string>"
1511 },
1512 "name" : {
1513 "description" : "Action name.",
1514 "maxLength" : 255,
1515 "type" : "string",
1516 "typetext" : "<string>"
1517 }
1518 }
1519 },
1520 "permissions" : {
1521 "check" : [
1522 "admin"
1523 ]
1524 },
1525 "protected" : 1,
1526 "proxyto" : "master",
1527 "returns" : {
1528 "description" : "The object ID.",
1529 "type" : "string"
1530 }
1531 }
1532 },
1533 "leaf" : 0,
1534 "path" : "/config/ruledb/action/disclaimer",
1535 "text" : "disclaimer"
1536 },
1537 {
1538 "children" : [
1539 {
1540 "info" : {
1541 "GET" : {
1542 "allowtoken" : 1,
1543 "description" : "Read 'Remove attachments' object settings.",
1544 "method" : "GET",
1545 "name" : "read_removeattachments",
1546 "parameters" : {
1547 "additionalProperties" : 0,
1548 "properties" : {
1549 "id" : {
1550 "description" : "Action Object ID.",
1551 "pattern" : "\\d+_\\d+",
1552 "type" : "string"
1553 }
1554 }
1555 },
1556 "permissions" : {
1557 "check" : [
1558 "admin",
1559 "audit"
1560 ]
1561 },
1562 "proxyto" : "master",
1563 "returns" : {
1564 "properties" : {
1565 "id" : {
1566 "type" : "string"
1567 }
1568 },
1569 "type" : "object"
1570 }
1571 },
1572 "PUT" : {
1573 "allowtoken" : 1,
1574 "description" : "Update 'Remove attachments' object.",
1575 "method" : "PUT",
1576 "name" : "update_removeattachments",
1577 "parameters" : {
1578 "additionalProperties" : 0,
1579 "properties" : {
1580 "all" : {
1581 "description" : "Remove all attachments",
1582 "optional" : 1,
1583 "type" : "boolean",
1584 "typetext" : "<boolean>"
1585 },
1586 "id" : {
1587 "description" : "Action Object ID.",
1588 "pattern" : "\\d+_\\d+",
1589 "type" : "string"
1590 },
1591 "info" : {
1592 "description" : "Informational comment.",
1593 "maxLength" : 255,
1594 "optional" : 1,
1595 "type" : "string",
1596 "typetext" : "<string>"
1597 },
1598 "name" : {
1599 "description" : "Action name.",
1600 "maxLength" : 255,
1601 "optional" : 1,
1602 "type" : "string",
1603 "typetext" : "<string>"
1604 },
1605 "quarantine" : {
1606 "default" : 0,
1607 "description" : "Copy original mail to attachment Quarantine.",
1608 "optional" : 1,
1609 "type" : "boolean",
1610 "typetext" : "<boolean>"
1611 },
1612 "text" : {
1613 "description" : "The replacement text.",
1614 "maxLength" : 2048,
1615 "type" : "string",
1616 "typetext" : "<string>"
1617 }
1618 }
1619 },
1620 "permissions" : {
1621 "check" : [
1622 "admin"
1623 ]
1624 },
1625 "protected" : 1,
1626 "proxyto" : "master",
1627 "returns" : {
1628 "type" : "null"
1629 }
1630 }
1631 },
1632 "leaf" : 1,
1633 "path" : "/config/ruledb/action/removeattachments/{id}",
1634 "text" : "{id}"
1635 }
1636 ],
1637 "info" : {
1638 "POST" : {
1639 "allowtoken" : 1,
1640 "description" : "Create 'Remove attachments' object.",
1641 "method" : "POST",
1642 "name" : "removeattachments",
1643 "parameters" : {
1644 "additionalProperties" : 0,
1645 "properties" : {
1646 "all" : {
1647 "description" : "Remove all attachments",
1648 "optional" : 1,
1649 "type" : "boolean",
1650 "typetext" : "<boolean>"
1651 },
1652 "info" : {
1653 "description" : "Informational comment.",
1654 "maxLength" : 255,
1655 "optional" : 1,
1656 "type" : "string",
1657 "typetext" : "<string>"
1658 },
1659 "name" : {
1660 "description" : "Action name.",
1661 "maxLength" : 255,
1662 "type" : "string",
1663 "typetext" : "<string>"
1664 },
1665 "quarantine" : {
1666 "default" : 0,
1667 "description" : "Copy original mail to attachment Quarantine.",
1668 "optional" : 1,
1669 "type" : "boolean",
1670 "typetext" : "<boolean>"
1671 },
1672 "text" : {
1673 "description" : "The replacement text.",
1674 "maxLength" : 2048,
1675 "type" : "string",
1676 "typetext" : "<string>"
1677 }
1678 }
1679 },
1680 "permissions" : {
1681 "check" : [
1682 "admin"
1683 ]
1684 },
1685 "protected" : 1,
1686 "proxyto" : "master",
1687 "returns" : {
1688 "description" : "The object ID.",
1689 "type" : "string"
1690 }
1691 }
1692 },
1693 "leaf" : 0,
1694 "path" : "/config/ruledb/action/removeattachments",
1695 "text" : "removeattachments"
1696 }
1697 ],
1698 "info" : {
1699 "GET" : {
1700 "allowtoken" : 1,
1701 "description" : "Directory index.",
1702 "method" : "GET",
1703 "name" : "index",
1704 "parameters" : {
1705 "additionalProperties" : 0
1706 },
1707 "permissions" : {
1708 "check" : [
1709 "admin",
1710 "audit"
1711 ]
1712 },
1713 "returns" : {
1714 "items" : {
1715 "properties" : {
1716 "subdir" : {
1717 "type" : "string"
1718 }
1719 },
1720 "type" : "object"
1721 },
1722 "links" : [
1723 {
1724 "href" : "{subdir}",
1725 "rel" : "child"
1726 }
1727 ],
1728 "type" : "array"
1729 }
1730 }
1731 },
1732 "leaf" : 0,
1733 "path" : "/config/ruledb/action",
1734 "text" : "action"
1735 },
1736 {
1737 "children" : [
1738 {
1739 "children" : [
1740 {
1741 "info" : {
1742 "GET" : {
1743 "allowtoken" : 1,
1744 "description" : "Get 'what' group properties",
1745 "method" : "GET",
1746 "name" : "get_config",
1747 "parameters" : {
1748 "additionalProperties" : 0,
1749 "properties" : {
1750 "ogroup" : {
1751 "description" : "Object Group ID.",
1752 "type" : "integer",
1753 "typetext" : "<integer>"
1754 }
1755 }
1756 },
1757 "permissions" : {
1758 "check" : [
1759 "admin",
1760 "audit"
1761 ]
1762 },
1763 "proxyto" : "master",
1764 "returns" : {
1765 "properties" : {
1766 "id" : {
1767 "type" : "integer"
1768 },
1769 "info" : {
1770 "type" : "string"
1771 },
1772 "name" : {
1773 "type" : "string"
1774 }
1775 },
1776 "type" : "object"
1777 }
1778 },
1779 "PUT" : {
1780 "allowtoken" : 1,
1781 "description" : "Modify 'what' group properties",
1782 "method" : "PUT",
1783 "name" : "set_config",
1784 "parameters" : {
1785 "additionalProperties" : 0,
1786 "properties" : {
1787 "info" : {
1788 "description" : "Informational comment.",
1789 "maxLength" : 255,
1790 "optional" : 1,
1791 "type" : "string",
1792 "typetext" : "<string>"
1793 },
1794 "name" : {
1795 "description" : "Group name.",
1796 "maxLength" : 255,
1797 "optional" : 1,
1798 "type" : "string",
1799 "typetext" : "<string>"
1800 },
1801 "ogroup" : {
1802 "description" : "Object Group ID.",
1803 "type" : "integer",
1804 "typetext" : "<integer>"
1805 }
1806 }
1807 },
1808 "permissions" : {
1809 "check" : [
1810 "admin"
1811 ]
1812 },
1813 "protected" : 1,
1814 "proxyto" : "master",
1815 "returns" : {
1816 "type" : "null"
1817 }
1818 }
1819 },
1820 "leaf" : 1,
1821 "path" : "/config/ruledb/what/{ogroup}/config",
1822 "text" : "config"
1823 },
1824 {
1825 "children" : [
1826 {
1827 "info" : {
1828 "DELETE" : {
1829 "allowtoken" : 1,
1830 "description" : "Remove an object from the 'what' group.",
1831 "method" : "DELETE",
1832 "name" : "delete_object",
1833 "parameters" : {
1834 "additionalProperties" : 0,
1835 "properties" : {
1836 "id" : {
1837 "description" : "Object ID.",
1838 "type" : "integer",
1839 "typetext" : "<integer>"
1840 },
1841 "ogroup" : {
1842 "description" : "Object Group ID.",
1843 "type" : "integer",
1844 "typetext" : "<integer>"
1845 }
1846 }
1847 },
1848 "permissions" : {
1849 "check" : [
1850 "admin"
1851 ]
1852 },
1853 "protected" : 1,
1854 "proxyto" : "master",
1855 "returns" : {
1856 "type" : "null"
1857 }
1858 }
1859 },
1860 "leaf" : 1,
1861 "path" : "/config/ruledb/what/{ogroup}/objects/{id}",
1862 "text" : "{id}"
1863 }
1864 ],
1865 "info" : {
1866 "GET" : {
1867 "allowtoken" : 1,
1868 "description" : "List 'what' group objects.",
1869 "method" : "GET",
1870 "name" : "objects",
1871 "parameters" : {
1872 "additionalProperties" : 0,
1873 "properties" : {
1874 "ogroup" : {
1875 "description" : "Object Group ID.",
1876 "type" : "integer",
1877 "typetext" : "<integer>"
1878 }
1879 }
1880 },
1881 "permissions" : {
1882 "check" : [
1883 "admin",
1884 "audit"
1885 ]
1886 },
1887 "proxyto" : "master",
1888 "returns" : {
1889 "items" : {
1890 "properties" : {
1891 "id" : {
1892 "type" : "integer"
1893 }
1894 },
1895 "type" : "object"
1896 },
1897 "links" : [
1898 {
1899 "href" : "{id}",
1900 "rel" : "child"
1901 }
1902 ],
1903 "type" : "array"
1904 }
1905 }
1906 },
1907 "leaf" : 0,
1908 "path" : "/config/ruledb/what/{ogroup}/objects",
1909 "text" : "objects"
1910 },
1911 {
1912 "children" : [
1913 {
1914 "info" : {
1915 "GET" : {
1916 "allowtoken" : 1,
1917 "description" : "Read 'ContentType Filter' object settings.",
1918 "method" : "GET",
1919 "name" : "read_contenttype",
1920 "parameters" : {
1921 "additionalProperties" : 0,
1922 "properties" : {
1923 "id" : {
1924 "description" : "Object ID.",
1925 "type" : "integer",
1926 "typetext" : "<integer>"
1927 },
1928 "ogroup" : {
1929 "description" : "Object Groups ID.",
1930 "type" : "integer",
1931 "typetext" : "<integer>"
1932 }
1933 }
1934 },
1935 "permissions" : {
1936 "check" : [
1937 "admin",
1938 "audit"
1939 ]
1940 },
1941 "proxyto" : "master",
1942 "returns" : {
1943 "properties" : {
1944 "id" : {
1945 "type" : "integer"
1946 }
1947 },
1948 "type" : "object"
1949 }
1950 },
1951 "PUT" : {
1952 "allowtoken" : 1,
1953 "description" : "Update 'ContentType Filter' object.",
1954 "method" : "PUT",
1955 "name" : "update_contenttype",
1956 "parameters" : {
1957 "additionalProperties" : 0,
1958 "properties" : {
1959 "contenttype" : {
1960 "description" : "Content Type",
1961 "maxLength" : 1024,
1962 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
1963 "type" : "string"
1964 },
1965 "id" : {
1966 "description" : "Object ID.",
1967 "type" : "integer",
1968 "typetext" : "<integer>"
1969 },
1970 "ogroup" : {
1971 "description" : "Object Groups ID.",
1972 "type" : "integer",
1973 "typetext" : "<integer>"
1974 }
1975 }
1976 },
1977 "permissions" : {
1978 "check" : [
1979 "admin"
1980 ]
1981 },
1982 "protected" : 1,
1983 "proxyto" : "master",
1984 "returns" : {
1985 "type" : "null"
1986 }
1987 }
1988 },
1989 "leaf" : 1,
1990 "path" : "/config/ruledb/what/{ogroup}/contenttype/{id}",
1991 "text" : "{id}"
1992 }
1993 ],
1994 "info" : {
1995 "POST" : {
1996 "allowtoken" : 1,
1997 "description" : "Add 'ContentType Filter' object.",
1998 "method" : "POST",
1999 "name" : "contenttype",
2000 "parameters" : {
2001 "additionalProperties" : 0,
2002 "properties" : {
2003 "contenttype" : {
2004 "description" : "Content Type",
2005 "maxLength" : 1024,
2006 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
2007 "type" : "string"
2008 },
2009 "ogroup" : {
2010 "description" : "Object Groups ID.",
2011 "type" : "integer",
2012 "typetext" : "<integer>"
2013 }
2014 }
2015 },
2016 "permissions" : {
2017 "check" : [
2018 "admin"
2019 ]
2020 },
2021 "protected" : 1,
2022 "proxyto" : "master",
2023 "returns" : {
2024 "description" : "The object ID.",
2025 "type" : "integer"
2026 }
2027 }
2028 },
2029 "leaf" : 0,
2030 "path" : "/config/ruledb/what/{ogroup}/contenttype",
2031 "text" : "contenttype"
2032 },
2033 {
2034 "children" : [
2035 {
2036 "info" : {
2037 "GET" : {
2038 "allowtoken" : 1,
2039 "description" : "Read 'Match Field' object settings.",
2040 "method" : "GET",
2041 "name" : "read_matchfield",
2042 "parameters" : {
2043 "additionalProperties" : 0,
2044 "properties" : {
2045 "id" : {
2046 "description" : "Object ID.",
2047 "type" : "integer",
2048 "typetext" : "<integer>"
2049 },
2050 "ogroup" : {
2051 "description" : "Object Groups ID.",
2052 "type" : "integer",
2053 "typetext" : "<integer>"
2054 }
2055 }
2056 },
2057 "permissions" : {
2058 "check" : [
2059 "admin",
2060 "audit"
2061 ]
2062 },
2063 "proxyto" : "master",
2064 "returns" : {
2065 "properties" : {
2066 "id" : {
2067 "type" : "integer"
2068 }
2069 },
2070 "type" : "object"
2071 }
2072 },
2073 "PUT" : {
2074 "allowtoken" : 1,
2075 "description" : "Update 'Match Field' object.",
2076 "method" : "PUT",
2077 "name" : "update_matchfield",
2078 "parameters" : {
2079 "additionalProperties" : 0,
2080 "properties" : {
2081 "field" : {
2082 "description" : "The Field",
2083 "maxLength" : 1024,
2084 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
2085 "type" : "string"
2086 },
2087 "id" : {
2088 "description" : "Object ID.",
2089 "type" : "integer",
2090 "typetext" : "<integer>"
2091 },
2092 "ogroup" : {
2093 "description" : "Object Groups ID.",
2094 "type" : "integer",
2095 "typetext" : "<integer>"
2096 },
2097 "value" : {
2098 "description" : "The Value",
2099 "maxLength" : 1024,
2100 "type" : "string",
2101 "typetext" : "<string>"
2102 }
2103 }
2104 },
2105 "permissions" : {
2106 "check" : [
2107 "admin"
2108 ]
2109 },
2110 "protected" : 1,
2111 "proxyto" : "master",
2112 "returns" : {
2113 "type" : "null"
2114 }
2115 }
2116 },
2117 "leaf" : 1,
2118 "path" : "/config/ruledb/what/{ogroup}/matchfield/{id}",
2119 "text" : "{id}"
2120 }
2121 ],
2122 "info" : {
2123 "POST" : {
2124 "allowtoken" : 1,
2125 "description" : "Add 'Match Field' object.",
2126 "method" : "POST",
2127 "name" : "matchfield",
2128 "parameters" : {
2129 "additionalProperties" : 0,
2130 "properties" : {
2131 "field" : {
2132 "description" : "The Field",
2133 "maxLength" : 1024,
2134 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
2135 "type" : "string"
2136 },
2137 "ogroup" : {
2138 "description" : "Object Groups ID.",
2139 "type" : "integer",
2140 "typetext" : "<integer>"
2141 },
2142 "value" : {
2143 "description" : "The Value",
2144 "maxLength" : 1024,
2145 "type" : "string",
2146 "typetext" : "<string>"
2147 }
2148 }
2149 },
2150 "permissions" : {
2151 "check" : [
2152 "admin"
2153 ]
2154 },
2155 "protected" : 1,
2156 "proxyto" : "master",
2157 "returns" : {
2158 "description" : "The object ID.",
2159 "type" : "integer"
2160 }
2161 }
2162 },
2163 "leaf" : 0,
2164 "path" : "/config/ruledb/what/{ogroup}/matchfield",
2165 "text" : "matchfield"
2166 },
2167 {
2168 "children" : [
2169 {
2170 "info" : {
2171 "GET" : {
2172 "allowtoken" : 1,
2173 "description" : "Read 'Spam Filter' object settings.",
2174 "method" : "GET",
2175 "name" : "read_spamfilter",
2176 "parameters" : {
2177 "additionalProperties" : 0,
2178 "properties" : {
2179 "id" : {
2180 "description" : "Object ID.",
2181 "type" : "integer",
2182 "typetext" : "<integer>"
2183 },
2184 "ogroup" : {
2185 "description" : "Object Groups ID.",
2186 "type" : "integer",
2187 "typetext" : "<integer>"
2188 }
2189 }
2190 },
2191 "permissions" : {
2192 "check" : [
2193 "admin",
2194 "audit"
2195 ]
2196 },
2197 "proxyto" : "master",
2198 "returns" : {
2199 "properties" : {
2200 "id" : {
2201 "type" : "integer"
2202 }
2203 },
2204 "type" : "object"
2205 }
2206 },
2207 "PUT" : {
2208 "allowtoken" : 1,
2209 "description" : "Update 'Spam Filter' object.",
2210 "method" : "PUT",
2211 "name" : "update_spamfilter",
2212 "parameters" : {
2213 "additionalProperties" : 0,
2214 "properties" : {
2215 "id" : {
2216 "description" : "Object ID.",
2217 "type" : "integer",
2218 "typetext" : "<integer>"
2219 },
2220 "ogroup" : {
2221 "description" : "Object Groups ID.",
2222 "type" : "integer",
2223 "typetext" : "<integer>"
2224 },
2225 "spamlevel" : {
2226 "description" : "Spam Level",
2227 "minimum" : 0,
2228 "type" : "integer",
2229 "typetext" : "<integer> (0 - N)"
2230 }
2231 }
2232 },
2233 "permissions" : {
2234 "check" : [
2235 "admin"
2236 ]
2237 },
2238 "protected" : 1,
2239 "proxyto" : "master",
2240 "returns" : {
2241 "type" : "null"
2242 }
2243 }
2244 },
2245 "leaf" : 1,
2246 "path" : "/config/ruledb/what/{ogroup}/spamfilter/{id}",
2247 "text" : "{id}"
2248 }
2249 ],
2250 "info" : {
2251 "POST" : {
2252 "allowtoken" : 1,
2253 "description" : "Add 'Spam Filter' object.",
2254 "method" : "POST",
2255 "name" : "spamfilter",
2256 "parameters" : {
2257 "additionalProperties" : 0,
2258 "properties" : {
2259 "ogroup" : {
2260 "description" : "Object Groups ID.",
2261 "type" : "integer",
2262 "typetext" : "<integer>"
2263 },
2264 "spamlevel" : {
2265 "description" : "Spam Level",
2266 "minimum" : 0,
2267 "type" : "integer",
2268 "typetext" : "<integer> (0 - N)"
2269 }
2270 }
2271 },
2272 "permissions" : {
2273 "check" : [
2274 "admin"
2275 ]
2276 },
2277 "protected" : 1,
2278 "proxyto" : "master",
2279 "returns" : {
2280 "description" : "The object ID.",
2281 "type" : "integer"
2282 }
2283 }
2284 },
2285 "leaf" : 0,
2286 "path" : "/config/ruledb/what/{ogroup}/spamfilter",
2287 "text" : "spamfilter"
2288 },
2289 {
2290 "children" : [
2291 {
2292 "info" : {
2293 "GET" : {
2294 "allowtoken" : 1,
2295 "description" : "Read 'Archive Filter' object settings.",
2296 "method" : "GET",
2297 "name" : "read_archivefilter",
2298 "parameters" : {
2299 "additionalProperties" : 0,
2300 "properties" : {
2301 "id" : {
2302 "description" : "Object ID.",
2303 "type" : "integer",
2304 "typetext" : "<integer>"
2305 },
2306 "ogroup" : {
2307 "description" : "Object Groups ID.",
2308 "type" : "integer",
2309 "typetext" : "<integer>"
2310 }
2311 }
2312 },
2313 "permissions" : {
2314 "check" : [
2315 "admin",
2316 "audit"
2317 ]
2318 },
2319 "proxyto" : "master",
2320 "returns" : {
2321 "properties" : {
2322 "id" : {
2323 "type" : "integer"
2324 }
2325 },
2326 "type" : "object"
2327 }
2328 },
2329 "PUT" : {
2330 "allowtoken" : 1,
2331 "description" : "Update 'Archive Filter' object.",
2332 "method" : "PUT",
2333 "name" : "update_archivefilter",
2334 "parameters" : {
2335 "additionalProperties" : 0,
2336 "properties" : {
2337 "contenttype" : {
2338 "description" : "Content Type",
2339 "maxLength" : 1024,
2340 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
2341 "type" : "string"
2342 },
2343 "id" : {
2344 "description" : "Object ID.",
2345 "type" : "integer",
2346 "typetext" : "<integer>"
2347 },
2348 "ogroup" : {
2349 "description" : "Object Groups ID.",
2350 "type" : "integer",
2351 "typetext" : "<integer>"
2352 }
2353 }
2354 },
2355 "permissions" : {
2356 "check" : [
2357 "admin"
2358 ]
2359 },
2360 "protected" : 1,
2361 "proxyto" : "master",
2362 "returns" : {
2363 "type" : "null"
2364 }
2365 }
2366 },
2367 "leaf" : 1,
2368 "path" : "/config/ruledb/what/{ogroup}/archivefilter/{id}",
2369 "text" : "{id}"
2370 }
2371 ],
2372 "info" : {
2373 "POST" : {
2374 "allowtoken" : 1,
2375 "description" : "Add 'Archive Filter' object.",
2376 "method" : "POST",
2377 "name" : "archivefilter",
2378 "parameters" : {
2379 "additionalProperties" : 0,
2380 "properties" : {
2381 "contenttype" : {
2382 "description" : "Content Type",
2383 "maxLength" : 1024,
2384 "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
2385 "type" : "string"
2386 },
2387 "ogroup" : {
2388 "description" : "Object Groups ID.",
2389 "type" : "integer",
2390 "typetext" : "<integer>"
2391 }
2392 }
2393 },
2394 "permissions" : {
2395 "check" : [
2396 "admin"
2397 ]
2398 },
2399 "protected" : 1,
2400 "proxyto" : "master",
2401 "returns" : {
2402 "description" : "The object ID.",
2403 "type" : "integer"
2404 }
2405 }
2406 },
2407 "leaf" : 0,
2408 "path" : "/config/ruledb/what/{ogroup}/archivefilter",
2409 "text" : "archivefilter"
2410 },
2411 {
2412 "children" : [
2413 {
2414 "info" : {
2415 "GET" : {
2416 "allowtoken" : 1,
2417 "description" : "Read 'Match Filename' object settings.",
2418 "method" : "GET",
2419 "name" : "read_filenamefilter",
2420 "parameters" : {
2421 "additionalProperties" : 0,
2422 "properties" : {
2423 "id" : {
2424 "description" : "Object ID.",
2425 "type" : "integer",
2426 "typetext" : "<integer>"
2427 },
2428 "ogroup" : {
2429 "description" : "Object Groups ID.",
2430 "type" : "integer",
2431 "typetext" : "<integer>"
2432 }
2433 }
2434 },
2435 "permissions" : {
2436 "check" : [
2437 "admin",
2438 "audit"
2439 ]
2440 },
2441 "proxyto" : "master",
2442 "returns" : {
2443 "properties" : {
2444 "id" : {
2445 "type" : "integer"
2446 }
2447 },
2448 "type" : "object"
2449 }
2450 },
2451 "PUT" : {
2452 "allowtoken" : 1,
2453 "description" : "Update 'Match Filename' object.",
2454 "method" : "PUT",
2455 "name" : "update_filenamefilter",
2456 "parameters" : {
2457 "additionalProperties" : 0,
2458 "properties" : {
2459 "filename" : {
2460 "description" : "Filename filter",
2461 "maxLength" : 1024,
2462 "type" : "string",
2463 "typetext" : "<string>"
2464 },
2465 "id" : {
2466 "description" : "Object ID.",
2467 "type" : "integer",
2468 "typetext" : "<integer>"
2469 },
2470 "ogroup" : {
2471 "description" : "Object Groups ID.",
2472 "type" : "integer",
2473 "typetext" : "<integer>"
2474 }
2475 }
2476 },
2477 "permissions" : {
2478 "check" : [
2479 "admin"
2480 ]
2481 },
2482 "protected" : 1,
2483 "proxyto" : "master",
2484 "returns" : {
2485 "type" : "null"
2486 }
2487 }
2488 },
2489 "leaf" : 1,
2490 "path" : "/config/ruledb/what/{ogroup}/filenamefilter/{id}",
2491 "text" : "{id}"
2492 }
2493 ],
2494 "info" : {
2495 "POST" : {
2496 "allowtoken" : 1,
2497 "description" : "Add 'Match Filename' object.",
2498 "method" : "POST",
2499 "name" : "filenamefilter",
2500 "parameters" : {
2501 "additionalProperties" : 0,
2502 "properties" : {
2503 "filename" : {
2504 "description" : "Filename filter",
2505 "maxLength" : 1024,
2506 "type" : "string",
2507 "typetext" : "<string>"
2508 },
2509 "ogroup" : {
2510 "description" : "Object Groups ID.",
2511 "type" : "integer",
2512 "typetext" : "<integer>"
2513 }
2514 }
2515 },
2516 "permissions" : {
2517 "check" : [
2518 "admin"
2519 ]
2520 },
2521 "protected" : 1,
2522 "proxyto" : "master",
2523 "returns" : {
2524 "description" : "The object ID.",
2525 "type" : "integer"
2526 }
2527 }
2528 },
2529 "leaf" : 0,
2530 "path" : "/config/ruledb/what/{ogroup}/filenamefilter",
2531 "text" : "filenamefilter"
2532 },
2533 {
2534 "children" : [
2535 {
2536 "info" : {
2537 "GET" : {
2538 "allowtoken" : 1,
2539 "description" : "Read 'Virus Filter' object settings.",
2540 "method" : "GET",
2541 "name" : "read_virusfilter",
2542 "parameters" : {
2543 "additionalProperties" : 0,
2544 "properties" : {
2545 "id" : {
2546 "description" : "Object ID.",
2547 "type" : "integer",
2548 "typetext" : "<integer>"
2549 },
2550 "ogroup" : {
2551 "description" : "Object Groups ID.",
2552 "type" : "integer",
2553 "typetext" : "<integer>"
2554 }
2555 }
2556 },
2557 "permissions" : {
2558 "check" : [
2559 "admin",
2560 "audit"
2561 ]
2562 },
2563 "proxyto" : "master",
2564 "returns" : {
2565 "properties" : {
2566 "id" : {
2567 "type" : "integer"
2568 }
2569 },
2570 "type" : "object"
2571 }
2572 },
2573 "PUT" : {
2574 "allowtoken" : 1,
2575 "description" : "Update 'Virus Filter' object.",
2576 "method" : "PUT",
2577 "name" : "update_virusfilter",
2578 "parameters" : {
2579 "additionalProperties" : 0,
2580 "properties" : {
2581 "id" : {
2582 "description" : "Object ID.",
2583 "type" : "integer",
2584 "typetext" : "<integer>"
2585 },
2586 "ogroup" : {
2587 "description" : "Object Groups ID.",
2588 "type" : "integer",
2589 "typetext" : "<integer>"
2590 }
2591 }
2592 },
2593 "permissions" : {
2594 "check" : [
2595 "admin"
2596 ]
2597 },
2598 "protected" : 1,
2599 "proxyto" : "master",
2600 "returns" : {
2601 "type" : "null"
2602 }
2603 }
2604 },
2605 "leaf" : 1,
2606 "path" : "/config/ruledb/what/{ogroup}/virusfilter/{id}",
2607 "text" : "{id}"
2608 }
2609 ],
2610 "info" : {
2611 "POST" : {
2612 "allowtoken" : 1,
2613 "description" : "Add 'Virus Filter' object.",
2614 "method" : "POST",
2615 "name" : "virusfilter",
2616 "parameters" : {
2617 "additionalProperties" : 0,
2618 "properties" : {
2619 "ogroup" : {
2620 "description" : "Object Groups ID.",
2621 "type" : "integer",
2622 "typetext" : "<integer>"
2623 }
2624 }
2625 },
2626 "permissions" : {
2627 "check" : [
2628 "admin"
2629 ]
2630 },
2631 "protected" : 1,
2632 "proxyto" : "master",
2633 "returns" : {
2634 "description" : "The object ID.",
2635 "type" : "integer"
2636 }
2637 }
2638 },
2639 "leaf" : 0,
2640 "path" : "/config/ruledb/what/{ogroup}/virusfilter",
2641 "text" : "virusfilter"
2642 },
2643 {
2644 "children" : [
2645 {
2646 "info" : {
2647 "GET" : {
2648 "allowtoken" : 1,
2649 "description" : "Read 'Match Archive Filename' object settings.",
2650 "method" : "GET",
2651 "name" : "read_archivefilenamefilter",
2652 "parameters" : {
2653 "additionalProperties" : 0,
2654 "properties" : {
2655 "id" : {
2656 "description" : "Object ID.",
2657 "type" : "integer",
2658 "typetext" : "<integer>"
2659 },
2660 "ogroup" : {
2661 "description" : "Object Groups ID.",
2662 "type" : "integer",
2663 "typetext" : "<integer>"
2664 }
2665 }
2666 },
2667 "permissions" : {
2668 "check" : [
2669 "admin",
2670 "audit"
2671 ]
2672 },
2673 "proxyto" : "master",
2674 "returns" : {
2675 "properties" : {
2676 "id" : {
2677 "type" : "integer"
2678 }
2679 },
2680 "type" : "object"
2681 }
2682 },
2683 "PUT" : {
2684 "allowtoken" : 1,
2685 "description" : "Update 'Match Archive Filename' object.",
2686 "method" : "PUT",
2687 "name" : "update_archivefilenamefilter",
2688 "parameters" : {
2689 "additionalProperties" : 0,
2690 "properties" : {
2691 "filename" : {
2692 "description" : "Filename filter",
2693 "maxLength" : 1024,
2694 "type" : "string",
2695 "typetext" : "<string>"
2696 },
2697 "id" : {
2698 "description" : "Object ID.",
2699 "type" : "integer",
2700 "typetext" : "<integer>"
2701 },
2702 "ogroup" : {
2703 "description" : "Object Groups ID.",
2704 "type" : "integer",
2705 "typetext" : "<integer>"
2706 }
2707 }
2708 },
2709 "permissions" : {
2710 "check" : [
2711 "admin"
2712 ]
2713 },
2714 "protected" : 1,
2715 "proxyto" : "master",
2716 "returns" : {
2717 "type" : "null"
2718 }
2719 }
2720 },
2721 "leaf" : 1,
2722 "path" : "/config/ruledb/what/{ogroup}/archivefilenamefilter/{id}",
2723 "text" : "{id}"
2724 }
2725 ],
2726 "info" : {
2727 "POST" : {
2728 "allowtoken" : 1,
2729 "description" : "Add 'Match Archive Filename' object.",
2730 "method" : "POST",
2731 "name" : "archivefilenamefilter",
2732 "parameters" : {
2733 "additionalProperties" : 0,
2734 "properties" : {
2735 "filename" : {
2736 "description" : "Filename filter",
2737 "maxLength" : 1024,
2738 "type" : "string",
2739 "typetext" : "<string>"
2740 },
2741 "ogroup" : {
2742 "description" : "Object Groups ID.",
2743 "type" : "integer",
2744 "typetext" : "<integer>"
2745 }
2746 }
2747 },
2748 "permissions" : {
2749 "check" : [
2750 "admin"
2751 ]
2752 },
2753 "protected" : 1,
2754 "proxyto" : "master",
2755 "returns" : {
2756 "description" : "The object ID.",
2757 "type" : "integer"
2758 }
2759 }
2760 },
2761 "leaf" : 0,
2762 "path" : "/config/ruledb/what/{ogroup}/archivefilenamefilter",
2763 "text" : "archivefilenamefilter"
2764 }
2765 ],
2766 "info" : {
2767 "DELETE" : {
2768 "allowtoken" : 1,
2769 "description" : "Delete a 'what' group.",
2770 "method" : "DELETE",
2771 "name" : "delete_{$oclass}_group",
2772 "parameters" : {
2773 "additionalProperties" : 0,
2774 "properties" : {
2775 "ogroup" : {
2776 "description" : "Object Group ID.",
2777 "type" : "integer",
2778 "typetext" : "<integer>"
2779 }
2780 }
2781 },
2782 "permissions" : {
2783 "check" : [
2784 "admin"
2785 ]
2786 },
2787 "protected" : 1,
2788 "proxyto" : "master",
2789 "returns" : {
2790 "type" : "null"
2791 }
2792 },
2793 "GET" : {
2794 "allowtoken" : 1,
2795 "description" : "Directory index.",
2796 "method" : "GET",
2797 "name" : "index",
2798 "parameters" : {
2799 "additionalProperties" : 0,
2800 "properties" : {
2801 "ogroup" : {
2802 "description" : "Object Group ID.",
2803 "type" : "integer",
2804 "typetext" : "<integer>"
2805 }
2806 }
2807 },
2808 "permissions" : {
2809 "check" : [
2810 "admin",
2811 "audit"
2812 ]
2813 },
2814 "returns" : {
2815 "items" : {
2816 "properties" : {
2817 "subdir" : {
2818 "type" : "string"
2819 }
2820 },
2821 "type" : "object"
2822 },
2823 "links" : [
2824 {
2825 "href" : "{subdir}",
2826 "rel" : "child"
2827 }
2828 ],
2829 "type" : "array"
2830 }
2831 }
2832 },
2833 "leaf" : 0,
2834 "path" : "/config/ruledb/what/{ogroup}",
2835 "text" : "{ogroup}"
2836 }
2837 ],
2838 "info" : {
2839 "GET" : {
2840 "allowtoken" : 1,
2841 "description" : "Get list of 'what' groups.",
2842 "method" : "GET",
2843 "name" : "list_what_groups",
2844 "parameters" : {
2845 "additionalProperties" : 0
2846 },
2847 "permissions" : {
2848 "check" : [
2849 "admin",
2850 "audit"
2851 ]
2852 },
2853 "proxyto" : "master",
2854 "returns" : {
2855 "items" : {
2856 "properties" : {
2857 "id" : {
2858 "type" : "integer"
2859 }
2860 },
2861 "type" : "object"
2862 },
2863 "type" : "array"
2864 }
2865 },
2866 "POST" : {
2867 "allowtoken" : 1,
2868 "description" : "Create a new 'what' group.",
2869 "method" : "POST",
2870 "name" : "create_what_group",
2871 "parameters" : {
2872 "additionalProperties" : 0,
2873 "properties" : {
2874 "info" : {
2875 "description" : "Informational comment.",
2876 "maxLength" : 255,
2877 "optional" : 1,
2878 "type" : "string",
2879 "typetext" : "<string>"
2880 },
2881 "name" : {
2882 "description" : "Group name.",
2883 "maxLength" : 255,
2884 "type" : "string",
2885 "typetext" : "<string>"
2886 }
2887 }
2888 },
2889 "permissions" : {
2890 "check" : [
2891 "admin"
2892 ]
2893 },
2894 "protected" : 1,
2895 "proxyto" : "master",
2896 "returns" : {
2897 "type" : "integer"
2898 }
2899 }
2900 },
2901 "leaf" : 0,
2902 "path" : "/config/ruledb/what",
2903 "text" : "what"
2904 },
2905 {
2906 "children" : [
2907 {
2908 "children" : [
2909 {
2910 "info" : {
2911 "GET" : {
2912 "allowtoken" : 1,
2913 "description" : "Get 'when' group properties",
2914 "method" : "GET",
2915 "name" : "get_config",
2916 "parameters" : {
2917 "additionalProperties" : 0,
2918 "properties" : {
2919 "ogroup" : {
2920 "description" : "Object Group ID.",
2921 "type" : "integer",
2922 "typetext" : "<integer>"
2923 }
2924 }
2925 },
2926 "permissions" : {
2927 "check" : [
2928 "admin",
2929 "audit"
2930 ]
2931 },
2932 "proxyto" : "master",
2933 "returns" : {
2934 "properties" : {
2935 "id" : {
2936 "type" : "integer"
2937 },
2938 "info" : {
2939 "type" : "string"
2940 },
2941 "name" : {
2942 "type" : "string"
2943 }
2944 },
2945 "type" : "object"
2946 }
2947 },
2948 "PUT" : {
2949 "allowtoken" : 1,
2950 "description" : "Modify 'when' group properties",
2951 "method" : "PUT",
2952 "name" : "set_config",
2953 "parameters" : {
2954 "additionalProperties" : 0,
2955 "properties" : {
2956 "info" : {
2957 "description" : "Informational comment.",
2958 "maxLength" : 255,
2959 "optional" : 1,
2960 "type" : "string",
2961 "typetext" : "<string>"
2962 },
2963 "name" : {
2964 "description" : "Group name.",
2965 "maxLength" : 255,
2966 "optional" : 1,
2967 "type" : "string",
2968 "typetext" : "<string>"
2969 },
2970 "ogroup" : {
2971 "description" : "Object Group ID.",
2972 "type" : "integer",
2973 "typetext" : "<integer>"
2974 }
2975 }
2976 },
2977 "permissions" : {
2978 "check" : [
2979 "admin"
2980 ]
2981 },
2982 "protected" : 1,
2983 "proxyto" : "master",
2984 "returns" : {
2985 "type" : "null"
2986 }
2987 }
2988 },
2989 "leaf" : 1,
2990 "path" : "/config/ruledb/when/{ogroup}/config",
2991 "text" : "config"
2992 },
2993 {
2994 "children" : [
2995 {
2996 "info" : {
2997 "DELETE" : {
2998 "allowtoken" : 1,
2999 "description" : "Remove an object from the 'when' group.",
3000 "method" : "DELETE",
3001 "name" : "delete_object",
3002 "parameters" : {
3003 "additionalProperties" : 0,
3004 "properties" : {
3005 "id" : {
3006 "description" : "Object ID.",
3007 "type" : "integer",
3008 "typetext" : "<integer>"
3009 },
3010 "ogroup" : {
3011 "description" : "Object Group ID.",
3012 "type" : "integer",
3013 "typetext" : "<integer>"
3014 }
3015 }
3016 },
3017 "permissions" : {
3018 "check" : [
3019 "admin"
3020 ]
3021 },
3022 "protected" : 1,
3023 "proxyto" : "master",
3024 "returns" : {
3025 "type" : "null"
3026 }
3027 }
3028 },
3029 "leaf" : 1,
3030 "path" : "/config/ruledb/when/{ogroup}/objects/{id}",
3031 "text" : "{id}"
3032 }
3033 ],
3034 "info" : {
3035 "GET" : {
3036 "allowtoken" : 1,
3037 "description" : "List 'when' group objects.",
3038 "method" : "GET",
3039 "name" : "objects",
3040 "parameters" : {
3041 "additionalProperties" : 0,
3042 "properties" : {
3043 "ogroup" : {
3044 "description" : "Object Group ID.",
3045 "type" : "integer",
3046 "typetext" : "<integer>"
3047 }
3048 }
3049 },
3050 "permissions" : {
3051 "check" : [
3052 "admin",
3053 "audit"
3054 ]
3055 },
3056 "proxyto" : "master",
3057 "returns" : {
3058 "items" : {
3059 "properties" : {
3060 "id" : {
3061 "type" : "integer"
3062 }
3063 },
3064 "type" : "object"
3065 },
3066 "links" : [
3067 {
3068 "href" : "{id}",
3069 "rel" : "child"
3070 }
3071 ],
3072 "type" : "array"
3073 }
3074 }
3075 },
3076 "leaf" : 0,
3077 "path" : "/config/ruledb/when/{ogroup}/objects",
3078 "text" : "objects"
3079 },
3080 {
3081 "children" : [
3082 {
3083 "info" : {
3084 "GET" : {
3085 "allowtoken" : 1,
3086 "description" : "Read 'TimeFrame' object settings.",
3087 "method" : "GET",
3088 "name" : "read_timeframe",
3089 "parameters" : {
3090 "additionalProperties" : 0,
3091 "properties" : {
3092 "id" : {
3093 "description" : "Object ID.",
3094 "type" : "integer",
3095 "typetext" : "<integer>"
3096 },
3097 "ogroup" : {
3098 "description" : "Object Groups ID.",
3099 "type" : "integer",
3100 "typetext" : "<integer>"
3101 }
3102 }
3103 },
3104 "permissions" : {
3105 "check" : [
3106 "admin",
3107 "audit"
3108 ]
3109 },
3110 "proxyto" : "master",
3111 "returns" : {
3112 "properties" : {
3113 "id" : {
3114 "type" : "integer"
3115 }
3116 },
3117 "type" : "object"
3118 }
3119 },
3120 "PUT" : {
3121 "allowtoken" : 1,
3122 "description" : "Update 'TimeFrame' object.",
3123 "method" : "PUT",
3124 "name" : "update_timeframe",
3125 "parameters" : {
3126 "additionalProperties" : 0,
3127 "properties" : {
3128 "end" : {
3129 "description" : "End time in `H:i` format (00:00).",
3130 "pattern" : "\\d?\\d:\\d?\\d",
3131 "type" : "string"
3132 },
3133 "id" : {
3134 "description" : "Object ID.",
3135 "type" : "integer",
3136 "typetext" : "<integer>"
3137 },
3138 "ogroup" : {
3139 "description" : "Object Groups ID.",
3140 "type" : "integer",
3141 "typetext" : "<integer>"
3142 },
3143 "start" : {
3144 "description" : "Start time in `H:i` format (00:00).",
3145 "pattern" : "\\d?\\d:\\d?\\d",
3146 "type" : "string"
3147 }
3148 }
3149 },
3150 "permissions" : {
3151 "check" : [
3152 "admin"
3153 ]
3154 },
3155 "protected" : 1,
3156 "proxyto" : "master",
3157 "returns" : {
3158 "type" : "null"
3159 }
3160 }
3161 },
3162 "leaf" : 1,
3163 "path" : "/config/ruledb/when/{ogroup}/timeframe/{id}",
3164 "text" : "{id}"
3165 }
3166 ],
3167 "info" : {
3168 "POST" : {
3169 "allowtoken" : 1,
3170 "description" : "Add 'TimeFrame' object.",
3171 "method" : "POST",
3172 "name" : "timeframe",
3173 "parameters" : {
3174 "additionalProperties" : 0,
3175 "properties" : {
3176 "end" : {
3177 "description" : "End time in `H:i` format (00:00).",
3178 "pattern" : "\\d?\\d:\\d?\\d",
3179 "type" : "string"
3180 },
3181 "ogroup" : {
3182 "description" : "Object Groups ID.",
3183 "type" : "integer",
3184 "typetext" : "<integer>"
3185 },
3186 "start" : {
3187 "description" : "Start time in `H:i` format (00:00).",
3188 "pattern" : "\\d?\\d:\\d?\\d",
3189 "type" : "string"
3190 }
3191 }
3192 },
3193 "permissions" : {
3194 "check" : [
3195 "admin"
3196 ]
3197 },
3198 "protected" : 1,
3199 "proxyto" : "master",
3200 "returns" : {
3201 "description" : "The object ID.",
3202 "type" : "integer"
3203 }
3204 }
3205 },
3206 "leaf" : 0,
3207 "path" : "/config/ruledb/when/{ogroup}/timeframe",
3208 "text" : "timeframe"
3209 }
3210 ],
3211 "info" : {
3212 "DELETE" : {
3213 "allowtoken" : 1,
3214 "description" : "Delete a 'when' group.",
3215 "method" : "DELETE",
3216 "name" : "delete_{$oclass}_group",
3217 "parameters" : {
3218 "additionalProperties" : 0,
3219 "properties" : {
3220 "ogroup" : {
3221 "description" : "Object Group ID.",
3222 "type" : "integer",
3223 "typetext" : "<integer>"
3224 }
3225 }
3226 },
3227 "permissions" : {
3228 "check" : [
3229 "admin"
3230 ]
3231 },
3232 "protected" : 1,
3233 "proxyto" : "master",
3234 "returns" : {
3235 "type" : "null"
3236 }
3237 },
3238 "GET" : {
3239 "allowtoken" : 1,
3240 "description" : "Directory index.",
3241 "method" : "GET",
3242 "name" : "index",
3243 "parameters" : {
3244 "additionalProperties" : 0,
3245 "properties" : {
3246 "ogroup" : {
3247 "description" : "Object Group ID.",
3248 "type" : "integer",
3249 "typetext" : "<integer>"
3250 }
3251 }
3252 },
3253 "permissions" : {
3254 "check" : [
3255 "admin",
3256 "audit"
3257 ]
3258 },
3259 "returns" : {
3260 "items" : {
3261 "properties" : {
3262 "subdir" : {
3263 "type" : "string"
3264 }
3265 },
3266 "type" : "object"
3267 },
3268 "links" : [
3269 {
3270 "href" : "{subdir}",
3271 "rel" : "child"
3272 }
3273 ],
3274 "type" : "array"
3275 }
3276 }
3277 },
3278 "leaf" : 0,
3279 "path" : "/config/ruledb/when/{ogroup}",
3280 "text" : "{ogroup}"
3281 }
3282 ],
3283 "info" : {
3284 "GET" : {
3285 "allowtoken" : 1,
3286 "description" : "Get list of 'when' groups.",
3287 "method" : "GET",
3288 "name" : "list_when_groups",
3289 "parameters" : {
3290 "additionalProperties" : 0
3291 },
3292 "permissions" : {
3293 "check" : [
3294 "admin",
3295 "audit"
3296 ]
3297 },
3298 "proxyto" : "master",
3299 "returns" : {
3300 "items" : {
3301 "properties" : {
3302 "id" : {
3303 "type" : "integer"
3304 }
3305 },
3306 "type" : "object"
3307 },
3308 "type" : "array"
3309 }
3310 },
3311 "POST" : {
3312 "allowtoken" : 1,
3313 "description" : "Create a new 'when' group.",
3314 "method" : "POST",
3315 "name" : "create_when_group",
3316 "parameters" : {
3317 "additionalProperties" : 0,
3318 "properties" : {
3319 "info" : {
3320 "description" : "Informational comment.",
3321 "maxLength" : 255,
3322 "optional" : 1,
3323 "type" : "string",
3324 "typetext" : "<string>"
3325 },
3326 "name" : {
3327 "description" : "Group name.",
3328 "maxLength" : 255,
3329 "type" : "string",
3330 "typetext" : "<string>"
3331 }
3332 }
3333 },
3334 "permissions" : {
3335 "check" : [
3336 "admin"
3337 ]
3338 },
3339 "protected" : 1,
3340 "proxyto" : "master",
3341 "returns" : {
3342 "type" : "integer"
3343 }
3344 }
3345 },
3346 "leaf" : 0,
3347 "path" : "/config/ruledb/when",
3348 "text" : "when"
3349 },
3350 {
3351 "children" : [
3352 {
3353 "children" : [
3354 {
3355 "info" : {
3356 "GET" : {
3357 "allowtoken" : 1,
3358 "description" : "Get 'who' group properties",
3359 "method" : "GET",
3360 "name" : "get_config",
3361 "parameters" : {
3362 "additionalProperties" : 0,
3363 "properties" : {
3364 "ogroup" : {
3365 "description" : "Object Group ID.",
3366 "type" : "integer",
3367 "typetext" : "<integer>"
3368 }
3369 }
3370 },
3371 "permissions" : {
3372 "check" : [
3373 "admin",
3374 "audit"
3375 ]
3376 },
3377 "proxyto" : "master",
3378 "returns" : {
3379 "properties" : {
3380 "id" : {
3381 "type" : "integer"
3382 },
3383 "info" : {
3384 "type" : "string"
3385 },
3386 "name" : {
3387 "type" : "string"
3388 }
3389 },
3390 "type" : "object"
3391 }
3392 },
3393 "PUT" : {
3394 "allowtoken" : 1,
3395 "description" : "Modify 'who' group properties",
3396 "method" : "PUT",
3397 "name" : "set_config",
3398 "parameters" : {
3399 "additionalProperties" : 0,
3400 "properties" : {
3401 "info" : {
3402 "description" : "Informational comment.",
3403 "maxLength" : 255,
3404 "optional" : 1,
3405 "type" : "string",
3406 "typetext" : "<string>"
3407 },
3408 "name" : {
3409 "description" : "Group name.",
3410 "maxLength" : 255,
3411 "optional" : 1,
3412 "type" : "string",
3413 "typetext" : "<string>"
3414 },
3415 "ogroup" : {
3416 "description" : "Object Group ID.",
3417 "type" : "integer",
3418 "typetext" : "<integer>"
3419 }
3420 }
3421 },
3422 "permissions" : {
3423 "check" : [
3424 "admin"
3425 ]
3426 },
3427 "protected" : 1,
3428 "proxyto" : "master",
3429 "returns" : {
3430 "type" : "null"
3431 }
3432 }
3433 },
3434 "leaf" : 1,
3435 "path" : "/config/ruledb/who/{ogroup}/config",
3436 "text" : "config"
3437 },
3438 {
3439 "children" : [
3440 {
3441 "info" : {
3442 "DELETE" : {
3443 "allowtoken" : 1,
3444 "description" : "Remove an object from the 'who' group.",
3445 "method" : "DELETE",
3446 "name" : "delete_object",
3447 "parameters" : {
3448 "additionalProperties" : 0,
3449 "properties" : {
3450 "id" : {
3451 "description" : "Object ID.",
3452 "type" : "integer",
3453 "typetext" : "<integer>"
3454 },
3455 "ogroup" : {
3456 "description" : "Object Group ID.",
3457 "type" : "integer",
3458 "typetext" : "<integer>"
3459 }
3460 }
3461 },
3462 "permissions" : {
3463 "check" : [
3464 "admin"
3465 ]
3466 },
3467 "protected" : 1,
3468 "proxyto" : "master",
3469 "returns" : {
3470 "type" : "null"
3471 }
3472 }
3473 },
3474 "leaf" : 1,
3475 "path" : "/config/ruledb/who/{ogroup}/objects/{id}",
3476 "text" : "{id}"
3477 }
3478 ],
3479 "info" : {
3480 "GET" : {
3481 "allowtoken" : 1,
3482 "description" : "List 'who' group objects.",
3483 "method" : "GET",
3484 "name" : "objects",
3485 "parameters" : {
3486 "additionalProperties" : 0,
3487 "properties" : {
3488 "ogroup" : {
3489 "description" : "Object Group ID.",
3490 "type" : "integer",
3491 "typetext" : "<integer>"
3492 }
3493 }
3494 },
3495 "permissions" : {
3496 "check" : [
3497 "admin",
3498 "audit"
3499 ]
3500 },
3501 "proxyto" : "master",
3502 "returns" : {
3503 "items" : {
3504 "properties" : {
3505 "id" : {
3506 "type" : "integer"
3507 }
3508 },
3509 "type" : "object"
3510 },
3511 "links" : [
3512 {
3513 "href" : "{id}",
3514 "rel" : "child"
3515 }
3516 ],
3517 "type" : "array"
3518 }
3519 }
3520 },
3521 "leaf" : 0,
3522 "path" : "/config/ruledb/who/{ogroup}/objects",
3523 "text" : "objects"
3524 },
3525 {
3526 "children" : [
3527 {
3528 "info" : {
3529 "GET" : {
3530 "allowtoken" : 1,
3531 "description" : "Read 'Mail address' object settings.",
3532 "method" : "GET",
3533 "name" : "read_email",
3534 "parameters" : {
3535 "additionalProperties" : 0,
3536 "properties" : {
3537 "id" : {
3538 "description" : "Object ID.",
3539 "type" : "integer",
3540 "typetext" : "<integer>"
3541 },
3542 "ogroup" : {
3543 "description" : "Object Groups ID.",
3544 "type" : "integer",
3545 "typetext" : "<integer>"
3546 }
3547 }
3548 },
3549 "permissions" : {
3550 "check" : [
3551 "admin",
3552 "audit"
3553 ]
3554 },
3555 "proxyto" : "master",
3556 "returns" : {
3557 "properties" : {
3558 "id" : {
3559 "type" : "integer"
3560 }
3561 },
3562 "type" : "object"
3563 }
3564 },
3565 "PUT" : {
3566 "allowtoken" : 1,
3567 "description" : "Update 'Mail address' object.",
3568 "method" : "PUT",
3569 "name" : "update_email",
3570 "parameters" : {
3571 "additionalProperties" : 0,
3572 "properties" : {
3573 "email" : {
3574 "description" : "Email address.",
3575 "format" : "email",
3576 "type" : "string",
3577 "typetext" : "<string>"
3578 },
3579 "id" : {
3580 "description" : "Object ID.",
3581 "type" : "integer",
3582 "typetext" : "<integer>"
3583 },
3584 "ogroup" : {
3585 "description" : "Object Groups ID.",
3586 "type" : "integer",
3587 "typetext" : "<integer>"
3588 }
3589 }
3590 },
3591 "permissions" : {
3592 "check" : [
3593 "admin"
3594 ]
3595 },
3596 "protected" : 1,
3597 "proxyto" : "master",
3598 "returns" : {
3599 "type" : "null"
3600 }
3601 }
3602 },
3603 "leaf" : 1,
3604 "path" : "/config/ruledb/who/{ogroup}/email/{id}",
3605 "text" : "{id}"
3606 }
3607 ],
3608 "info" : {
3609 "POST" : {
3610 "allowtoken" : 1,
3611 "description" : "Add 'Mail address' object.",
3612 "method" : "POST",
3613 "name" : "email",
3614 "parameters" : {
3615 "additionalProperties" : 0,
3616 "properties" : {
3617 "email" : {
3618 "description" : "Email address.",
3619 "format" : "email",
3620 "type" : "string",
3621 "typetext" : "<string>"
3622 },
3623 "ogroup" : {
3624 "description" : "Object Groups ID.",
3625 "type" : "integer",
3626 "typetext" : "<integer>"
3627 }
3628 }
3629 },
3630 "permissions" : {
3631 "check" : [
3632 "admin"
3633 ]
3634 },
3635 "protected" : 1,
3636 "proxyto" : "master",
3637 "returns" : {
3638 "description" : "The object ID.",
3639 "type" : "integer"
3640 }
3641 }
3642 },
3643 "leaf" : 0,
3644 "path" : "/config/ruledb/who/{ogroup}/email",
3645 "text" : "email"
3646 },
3647 {
3648 "children" : [
3649 {
3650 "info" : {
3651 "GET" : {
3652 "allowtoken" : 1,
3653 "description" : "Read 'Domain' object settings.",
3654 "method" : "GET",
3655 "name" : "read_domain",
3656 "parameters" : {
3657 "additionalProperties" : 0,
3658 "properties" : {
3659 "id" : {
3660 "description" : "Object ID.",
3661 "type" : "integer",
3662 "typetext" : "<integer>"
3663 },
3664 "ogroup" : {
3665 "description" : "Object Groups ID.",
3666 "type" : "integer",
3667 "typetext" : "<integer>"
3668 }
3669 }
3670 },
3671 "permissions" : {
3672 "check" : [
3673 "admin",
3674 "audit"
3675 ]
3676 },
3677 "proxyto" : "master",
3678 "returns" : {
3679 "properties" : {
3680 "id" : {
3681 "type" : "integer"
3682 }
3683 },
3684 "type" : "object"
3685 }
3686 },
3687 "PUT" : {
3688 "allowtoken" : 1,
3689 "description" : "Update 'Domain' object.",
3690 "method" : "PUT",
3691 "name" : "update_domain",
3692 "parameters" : {
3693 "additionalProperties" : 0,
3694 "properties" : {
3695 "domain" : {
3696 "description" : "DNS domain name (Sender).",
3697 "format" : "dns-name",
3698 "type" : "string",
3699 "typetext" : "<string>"
3700 },
3701 "id" : {
3702 "description" : "Object ID.",
3703 "type" : "integer",
3704 "typetext" : "<integer>"
3705 },
3706 "ogroup" : {
3707 "description" : "Object Groups ID.",
3708 "type" : "integer",
3709 "typetext" : "<integer>"
3710 }
3711 }
3712 },
3713 "permissions" : {
3714 "check" : [
3715 "admin"
3716 ]
3717 },
3718 "protected" : 1,
3719 "proxyto" : "master",
3720 "returns" : {
3721 "type" : "null"
3722 }
3723 }
3724 },
3725 "leaf" : 1,
3726 "path" : "/config/ruledb/who/{ogroup}/domain/{id}",
3727 "text" : "{id}"
3728 }
3729 ],
3730 "info" : {
3731 "POST" : {
3732 "allowtoken" : 1,
3733 "description" : "Add 'Domain' object.",
3734 "method" : "POST",
3735 "name" : "domain",
3736 "parameters" : {
3737 "additionalProperties" : 0,
3738 "properties" : {
3739 "domain" : {
3740 "description" : "DNS domain name (Sender).",
3741 "format" : "dns-name",
3742 "type" : "string",
3743 "typetext" : "<string>"
3744 },
3745 "ogroup" : {
3746 "description" : "Object Groups ID.",
3747 "type" : "integer",
3748 "typetext" : "<integer>"
3749 }
3750 }
3751 },
3752 "permissions" : {
3753 "check" : [
3754 "admin"
3755 ]
3756 },
3757 "protected" : 1,
3758 "proxyto" : "master",
3759 "returns" : {
3760 "description" : "The object ID.",
3761 "type" : "integer"
3762 }
3763 }
3764 },
3765 "leaf" : 0,
3766 "path" : "/config/ruledb/who/{ogroup}/domain",
3767 "text" : "domain"
3768 },
3769 {
3770 "children" : [
3771 {
3772 "info" : {
3773 "GET" : {
3774 "allowtoken" : 1,
3775 "description" : "Read 'Regular Expression' object settings.",
3776 "method" : "GET",
3777 "name" : "read_regex",
3778 "parameters" : {
3779 "additionalProperties" : 0,
3780 "properties" : {
3781 "id" : {
3782 "description" : "Object ID.",
3783 "type" : "integer",
3784 "typetext" : "<integer>"
3785 },
3786 "ogroup" : {
3787 "description" : "Object Groups ID.",
3788 "type" : "integer",
3789 "typetext" : "<integer>"
3790 }
3791 }
3792 },
3793 "permissions" : {
3794 "check" : [
3795 "admin",
3796 "audit"
3797 ]
3798 },
3799 "proxyto" : "master",
3800 "returns" : {
3801 "properties" : {
3802 "id" : {
3803 "type" : "integer"
3804 }
3805 },
3806 "type" : "object"
3807 }
3808 },
3809 "PUT" : {
3810 "allowtoken" : 1,
3811 "description" : "Update 'Regular Expression' object.",
3812 "method" : "PUT",
3813 "name" : "update_regex",
3814 "parameters" : {
3815 "additionalProperties" : 0,
3816 "properties" : {
3817 "id" : {
3818 "description" : "Object ID.",
3819 "type" : "integer",
3820 "typetext" : "<integer>"
3821 },
3822 "ogroup" : {
3823 "description" : "Object Groups ID.",
3824 "type" : "integer",
3825 "typetext" : "<integer>"
3826 },
3827 "regex" : {
3828 "description" : "Email address regular expression.",
3829 "maxLength" : 1024,
3830 "type" : "string",
3831 "typetext" : "<string>"
3832 }
3833 }
3834 },
3835 "permissions" : {
3836 "check" : [
3837 "admin"
3838 ]
3839 },
3840 "protected" : 1,
3841 "proxyto" : "master",
3842 "returns" : {
3843 "type" : "null"
3844 }
3845 }
3846 },
3847 "leaf" : 1,
3848 "path" : "/config/ruledb/who/{ogroup}/regex/{id}",
3849 "text" : "{id}"
3850 }
3851 ],
3852 "info" : {
3853 "POST" : {
3854 "allowtoken" : 1,
3855 "description" : "Add 'Regular Expression' object.",
3856 "method" : "POST",
3857 "name" : "regex",
3858 "parameters" : {
3859 "additionalProperties" : 0,
3860 "properties" : {
3861 "ogroup" : {
3862 "description" : "Object Groups ID.",
3863 "type" : "integer",
3864 "typetext" : "<integer>"
3865 },
3866 "regex" : {
3867 "description" : "Email address regular expression.",
3868 "maxLength" : 1024,
3869 "type" : "string",
3870 "typetext" : "<string>"
3871 }
3872 }
3873 },
3874 "permissions" : {
3875 "check" : [
3876 "admin"
3877 ]
3878 },
3879 "protected" : 1,
3880 "proxyto" : "master",
3881 "returns" : {
3882 "description" : "The object ID.",
3883 "type" : "integer"
3884 }
3885 }
3886 },
3887 "leaf" : 0,
3888 "path" : "/config/ruledb/who/{ogroup}/regex",
3889 "text" : "regex"
3890 },
3891 {
3892 "children" : [
3893 {
3894 "info" : {
3895 "GET" : {
3896 "allowtoken" : 1,
3897 "description" : "Read 'IP Address' object settings.",
3898 "method" : "GET",
3899 "name" : "read_ip",
3900 "parameters" : {
3901 "additionalProperties" : 0,
3902 "properties" : {
3903 "id" : {
3904 "description" : "Object ID.",
3905 "type" : "integer",
3906 "typetext" : "<integer>"
3907 },
3908 "ogroup" : {
3909 "description" : "Object Groups ID.",
3910 "type" : "integer",
3911 "typetext" : "<integer>"
3912 }
3913 }
3914 },
3915 "permissions" : {
3916 "check" : [
3917 "admin",
3918 "audit"
3919 ]
3920 },
3921 "proxyto" : "master",
3922 "returns" : {
3923 "properties" : {
3924 "id" : {
3925 "type" : "integer"
3926 }
3927 },
3928 "type" : "object"
3929 }
3930 },
3931 "PUT" : {
3932 "allowtoken" : 1,
3933 "description" : "Update 'IP Address' object.",
3934 "method" : "PUT",
3935 "name" : "update_ip",
3936 "parameters" : {
3937 "additionalProperties" : 0,
3938 "properties" : {
3939 "id" : {
3940 "description" : "Object ID.",
3941 "type" : "integer",
3942 "typetext" : "<integer>"
3943 },
3944 "ip" : {
3945 "description" : "IP address",
3946 "format" : "ip",
3947 "type" : "string",
3948 "typetext" : "<string>"
3949 },
3950 "ogroup" : {
3951 "description" : "Object Groups ID.",
3952 "type" : "integer",
3953 "typetext" : "<integer>"
3954 }
3955 }
3956 },
3957 "permissions" : {
3958 "check" : [
3959 "admin"
3960 ]
3961 },
3962 "protected" : 1,
3963 "proxyto" : "master",
3964 "returns" : {
3965 "type" : "null"
3966 }
3967 }
3968 },
3969 "leaf" : 1,
3970 "path" : "/config/ruledb/who/{ogroup}/ip/{id}",
3971 "text" : "{id}"
3972 }
3973 ],
3974 "info" : {
3975 "POST" : {
3976 "allowtoken" : 1,
3977 "description" : "Add 'IP Address' object.",
3978 "method" : "POST",
3979 "name" : "ip",
3980 "parameters" : {
3981 "additionalProperties" : 0,
3982 "properties" : {
3983 "ip" : {
3984 "description" : "IP address",
3985 "format" : "ip",
3986 "type" : "string",
3987 "typetext" : "<string>"
3988 },
3989 "ogroup" : {
3990 "description" : "Object Groups ID.",
3991 "type" : "integer",
3992 "typetext" : "<integer>"
3993 }
3994 }
3995 },
3996 "permissions" : {
3997 "check" : [
3998 "admin"
3999 ]
4000 },
4001 "protected" : 1,
4002 "proxyto" : "master",
4003 "returns" : {
4004 "description" : "The object ID.",
4005 "type" : "integer"
4006 }
4007 }
4008 },
4009 "leaf" : 0,
4010 "path" : "/config/ruledb/who/{ogroup}/ip",
4011 "text" : "ip"
4012 },
4013 {
4014 "children" : [
4015 {
4016 "info" : {
4017 "GET" : {
4018 "allowtoken" : 1,
4019 "description" : "Read 'IP Network' object settings.",
4020 "method" : "GET",
4021 "name" : "read_network",
4022 "parameters" : {
4023 "additionalProperties" : 0,
4024 "properties" : {
4025 "id" : {
4026 "description" : "Object ID.",
4027 "type" : "integer",
4028 "typetext" : "<integer>"
4029 },
4030 "ogroup" : {
4031 "description" : "Object Groups ID.",
4032 "type" : "integer",
4033 "typetext" : "<integer>"
4034 }
4035 }
4036 },
4037 "permissions" : {
4038 "check" : [
4039 "admin",
4040 "audit"
4041 ]
4042 },
4043 "proxyto" : "master",
4044 "returns" : {
4045 "properties" : {
4046 "id" : {
4047 "type" : "integer"
4048 }
4049 },
4050 "type" : "object"
4051 }
4052 },
4053 "PUT" : {
4054 "allowtoken" : 1,
4055 "description" : "Update 'IP Network' object.",
4056 "method" : "PUT",
4057 "name" : "update_network",
4058 "parameters" : {
4059 "additionalProperties" : 0,
4060 "properties" : {
4061 "cidr" : {
4062 "description" : "Network address in CIDR notation.",
4063 "format" : "CIDR",
4064 "type" : "string",
4065 "typetext" : "<string>"
4066 },
4067 "id" : {
4068 "description" : "Object ID.",
4069 "type" : "integer",
4070 "typetext" : "<integer>"
4071 },
4072 "ogroup" : {
4073 "description" : "Object Groups ID.",
4074 "type" : "integer",
4075 "typetext" : "<integer>"
4076 }
4077 }
4078 },
4079 "permissions" : {
4080 "check" : [
4081 "admin"
4082 ]
4083 },
4084 "protected" : 1,
4085 "proxyto" : "master",
4086 "returns" : {
4087 "type" : "null"
4088 }
4089 }
4090 },
4091 "leaf" : 1,
4092 "path" : "/config/ruledb/who/{ogroup}/network/{id}",
4093 "text" : "{id}"
4094 }
4095 ],
4096 "info" : {
4097 "POST" : {
4098 "allowtoken" : 1,
4099 "description" : "Add 'IP Network' object.",
4100 "method" : "POST",
4101 "name" : "network",
4102 "parameters" : {
4103 "additionalProperties" : 0,
4104 "properties" : {
4105 "cidr" : {
4106 "description" : "Network address in CIDR notation.",
4107 "format" : "CIDR",
4108 "type" : "string",
4109 "typetext" : "<string>"
4110 },
4111 "ogroup" : {
4112 "description" : "Object Groups ID.",
4113 "type" : "integer",
4114 "typetext" : "<integer>"
4115 }
4116 }
4117 },
4118 "permissions" : {
4119 "check" : [
4120 "admin"
4121 ]
4122 },
4123 "protected" : 1,
4124 "proxyto" : "master",
4125 "returns" : {
4126 "description" : "The object ID.",
4127 "type" : "integer"
4128 }
4129 }
4130 },
4131 "leaf" : 0,
4132 "path" : "/config/ruledb/who/{ogroup}/network",
4133 "text" : "network"
4134 },
4135 {
4136 "children" : [
4137 {
4138 "info" : {
4139 "GET" : {
4140 "allowtoken" : 1,
4141 "description" : "Read 'LDAP Group' object settings.",
4142 "method" : "GET",
4143 "name" : "read_ldap",
4144 "parameters" : {
4145 "additionalProperties" : 0,
4146 "properties" : {
4147 "id" : {
4148 "description" : "Object ID.",
4149 "type" : "integer",
4150 "typetext" : "<integer>"
4151 },
4152 "ogroup" : {
4153 "description" : "Object Groups ID.",
4154 "type" : "integer",
4155 "typetext" : "<integer>"
4156 }
4157 }
4158 },
4159 "permissions" : {
4160 "check" : [
4161 "admin",
4162 "audit"
4163 ]
4164 },
4165 "proxyto" : "master",
4166 "returns" : {
4167 "properties" : {
4168 "id" : {
4169 "type" : "integer"
4170 }
4171 },
4172 "type" : "object"
4173 }
4174 },
4175 "PUT" : {
4176 "allowtoken" : 1,
4177 "description" : "Update 'LDAP Group' object.",
4178 "method" : "PUT",
4179 "name" : "update_ldap",
4180 "parameters" : {
4181 "additionalProperties" : 0,
4182 "properties" : {
4183 "group" : {
4184 "description" : "LDAP Group DN",
4185 "maxLength" : 1024,
4186 "minLength" : 1,
4187 "optional" : 1,
4188 "type" : "string",
4189 "typetext" : "<string>"
4190 },
4191 "id" : {
4192 "description" : "Object ID.",
4193 "type" : "integer",
4194 "typetext" : "<integer>"
4195 },
4196 "mode" : {
4197 "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.",
4198 "enum" : [
4199 "any",
4200 "none",
4201 "group"
4202 ],
4203 "type" : "string"
4204 },
4205 "ogroup" : {
4206 "description" : "Object Groups ID.",
4207 "type" : "integer",
4208 "typetext" : "<integer>"
4209 },
4210 "profile" : {
4211 "description" : "Profile ID.",
4212 "format" : "pve-configid",
4213 "optional" : 1,
4214 "type" : "string",
4215 "typetext" : "<string>"
4216 }
4217 }
4218 },
4219 "permissions" : {
4220 "check" : [
4221 "admin"
4222 ]
4223 },
4224 "protected" : 1,
4225 "proxyto" : "master",
4226 "returns" : {
4227 "type" : "null"
4228 }
4229 }
4230 },
4231 "leaf" : 1,
4232 "path" : "/config/ruledb/who/{ogroup}/ldap/{id}",
4233 "text" : "{id}"
4234 }
4235 ],
4236 "info" : {
4237 "POST" : {
4238 "allowtoken" : 1,
4239 "description" : "Add 'LDAP Group' object.",
4240 "method" : "POST",
4241 "name" : "ldap",
4242 "parameters" : {
4243 "additionalProperties" : 0,
4244 "properties" : {
4245 "group" : {
4246 "description" : "LDAP Group DN",
4247 "maxLength" : 1024,
4248 "minLength" : 1,
4249 "optional" : 1,
4250 "type" : "string",
4251 "typetext" : "<string>"
4252 },
4253 "mode" : {
4254 "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.",
4255 "enum" : [
4256 "any",
4257 "none",
4258 "group"
4259 ],
4260 "type" : "string"
4261 },
4262 "ogroup" : {
4263 "description" : "Object Groups ID.",
4264 "type" : "integer",
4265 "typetext" : "<integer>"
4266 },
4267 "profile" : {
4268 "description" : "Profile ID.",
4269 "format" : "pve-configid",
4270 "optional" : 1,
4271 "type" : "string",
4272 "typetext" : "<string>"
4273 }
4274 }
4275 },
4276 "permissions" : {
4277 "check" : [
4278 "admin"
4279 ]
4280 },
4281 "protected" : 1,
4282 "proxyto" : "master",
4283 "returns" : {
4284 "description" : "The object ID.",
4285 "type" : "integer"
4286 }
4287 }
4288 },
4289 "leaf" : 0,
4290 "path" : "/config/ruledb/who/{ogroup}/ldap",
4291 "text" : "ldap"
4292 },
4293 {
4294 "children" : [
4295 {
4296 "info" : {
4297 "GET" : {
4298 "allowtoken" : 1,
4299 "description" : "Read 'LDAP User' object settings.",
4300 "method" : "GET",
4301 "name" : "read_ldapuser",
4302 "parameters" : {
4303 "additionalProperties" : 0,
4304 "properties" : {
4305 "id" : {
4306 "description" : "Object ID.",
4307 "type" : "integer",
4308 "typetext" : "<integer>"
4309 },
4310 "ogroup" : {
4311 "description" : "Object Groups ID.",
4312 "type" : "integer",
4313 "typetext" : "<integer>"
4314 }
4315 }
4316 },
4317 "permissions" : {
4318 "check" : [
4319 "admin",
4320 "audit"
4321 ]
4322 },
4323 "proxyto" : "master",
4324 "returns" : {
4325 "properties" : {
4326 "id" : {
4327 "type" : "integer"
4328 }
4329 },
4330 "type" : "object"
4331 }
4332 },
4333 "PUT" : {
4334 "allowtoken" : 1,
4335 "description" : "Update 'LDAP User' object.",
4336 "method" : "PUT",
4337 "name" : "update_ldapuser",
4338 "parameters" : {
4339 "additionalProperties" : 0,
4340 "properties" : {
4341 "account" : {
4342 "description" : "LDAP user account name.",
4343 "maxLength" : 1024,
4344 "minLength" : 1,
4345 "type" : "string",
4346 "typetext" : "<string>"
4347 },
4348 "id" : {
4349 "description" : "Object ID.",
4350 "type" : "integer",
4351 "typetext" : "<integer>"
4352 },
4353 "ogroup" : {
4354 "description" : "Object Groups ID.",
4355 "type" : "integer",
4356 "typetext" : "<integer>"
4357 },
4358 "profile" : {
4359 "description" : "Profile ID.",
4360 "format" : "pve-configid",
4361 "type" : "string",
4362 "typetext" : "<string>"
4363 }
4364 }
4365 },
4366 "permissions" : {
4367 "check" : [
4368 "admin"
4369 ]
4370 },
4371 "protected" : 1,
4372 "proxyto" : "master",
4373 "returns" : {
4374 "type" : "null"
4375 }
4376 }
4377 },
4378 "leaf" : 1,
4379 "path" : "/config/ruledb/who/{ogroup}/ldapuser/{id}",
4380 "text" : "{id}"
4381 }
4382 ],
4383 "info" : {
4384 "POST" : {
4385 "allowtoken" : 1,
4386 "description" : "Add 'LDAP User' object.",
4387 "method" : "POST",
4388 "name" : "ldapuser",
4389 "parameters" : {
4390 "additionalProperties" : 0,
4391 "properties" : {
4392 "account" : {
4393 "description" : "LDAP user account name.",
4394 "maxLength" : 1024,
4395 "minLength" : 1,
4396 "type" : "string",
4397 "typetext" : "<string>"
4398 },
4399 "ogroup" : {
4400 "description" : "Object Groups ID.",
4401 "type" : "integer",
4402 "typetext" : "<integer>"
4403 },
4404 "profile" : {
4405 "description" : "Profile ID.",
4406 "format" : "pve-configid",
4407 "type" : "string",
4408 "typetext" : "<string>"
4409 }
4410 }
4411 },
4412 "permissions" : {
4413 "check" : [
4414 "admin"
4415 ]
4416 },
4417 "protected" : 1,
4418 "proxyto" : "master",
4419 "returns" : {
4420 "description" : "The object ID.",
4421 "type" : "integer"
4422 }
4423 }
4424 },
4425 "leaf" : 0,
4426 "path" : "/config/ruledb/who/{ogroup}/ldapuser",
4427 "text" : "ldapuser"
4428 }
4429 ],
4430 "info" : {
4431 "DELETE" : {
4432 "allowtoken" : 1,
4433 "description" : "Delete a 'who' group.",
4434 "method" : "DELETE",
4435 "name" : "delete_{$oclass}_group",
4436 "parameters" : {
4437 "additionalProperties" : 0,
4438 "properties" : {
4439 "ogroup" : {
4440 "description" : "Object Group ID.",
4441 "type" : "integer",
4442 "typetext" : "<integer>"
4443 }
4444 }
4445 },
4446 "permissions" : {
4447 "check" : [
4448 "admin"
4449 ]
4450 },
4451 "protected" : 1,
4452 "proxyto" : "master",
4453 "returns" : {
4454 "type" : "null"
4455 }
4456 },
4457 "GET" : {
4458 "allowtoken" : 1,
4459 "description" : "Directory index.",
4460 "method" : "GET",
4461 "name" : "index",
4462 "parameters" : {
4463 "additionalProperties" : 0,
4464 "properties" : {
4465 "ogroup" : {
4466 "description" : "Object Group ID.",
4467 "type" : "integer",
4468 "typetext" : "<integer>"
4469 }
4470 }
4471 },
4472 "permissions" : {
4473 "check" : [
4474 "admin",
4475 "audit"
4476 ]
4477 },
4478 "returns" : {
4479 "items" : {
4480 "properties" : {
4481 "subdir" : {
4482 "type" : "string"
4483 }
4484 },
4485 "type" : "object"
4486 },
4487 "links" : [
4488 {
4489 "href" : "{subdir}",
4490 "rel" : "child"
4491 }
4492 ],
4493 "type" : "array"
4494 }
4495 }
4496 },
4497 "leaf" : 0,
4498 "path" : "/config/ruledb/who/{ogroup}",
4499 "text" : "{ogroup}"
4500 }
4501 ],
4502 "info" : {
4503 "GET" : {
4504 "allowtoken" : 1,
4505 "description" : "Get list of 'who' groups.",
4506 "method" : "GET",
4507 "name" : "list_who_groups",
4508 "parameters" : {
4509 "additionalProperties" : 0
4510 },
4511 "permissions" : {
4512 "check" : [
4513 "admin",
4514 "audit"
4515 ]
4516 },
4517 "proxyto" : "master",
4518 "returns" : {
4519 "items" : {
4520 "properties" : {
4521 "id" : {
4522 "type" : "integer"
4523 }
4524 },
4525 "type" : "object"
4526 },
4527 "type" : "array"
4528 }
4529 },
4530 "POST" : {
4531 "allowtoken" : 1,
4532 "description" : "Create a new 'who' group.",
4533 "method" : "POST",
4534 "name" : "create_who_group",
4535 "parameters" : {
4536 "additionalProperties" : 0,
4537 "properties" : {
4538 "info" : {
4539 "description" : "Informational comment.",
4540 "maxLength" : 255,
4541 "optional" : 1,
4542 "type" : "string",
4543 "typetext" : "<string>"
4544 },
4545 "name" : {
4546 "description" : "Group name.",
4547 "maxLength" : 255,
4548 "type" : "string",
4549 "typetext" : "<string>"
4550 }
4551 }
4552 },
4553 "permissions" : {
4554 "check" : [
4555 "admin"
4556 ]
4557 },
4558 "protected" : 1,
4559 "proxyto" : "master",
4560 "returns" : {
4561 "type" : "integer"
4562 }
4563 }
4564 },
4565 "leaf" : 0,
4566 "path" : "/config/ruledb/who",
4567 "text" : "who"
4568 }
4569 ],
4570 "info" : {
4571 "GET" : {
4572 "allowtoken" : 1,
4573 "description" : "Directory index.",
4574 "method" : "GET",
4575 "name" : "index",
4576 "parameters" : {
4577 "additionalProperties" : 0
4578 },
4579 "permissions" : {
4580 "check" : [
4581 "admin",
4582 "audit"
4583 ]
4584 },
4585 "returns" : {
4586 "items" : {
4587 "properties" : {},
4588 "type" : "object"
4589 },
4590 "links" : [
4591 {
4592 "href" : "{name}",
4593 "rel" : "child"
4594 }
4595 ],
4596 "type" : "array"
4597 }
4598 },
4599 "POST" : {
4600 "allowtoken" : 1,
4601 "description" : "Reset PMG rule database back to factory defaults.",
4602 "method" : "POST",
4603 "name" : "reset_ruledb",
4604 "parameters" : {
4605 "additionalProperties" : 0
4606 },
4607 "permissions" : {
4608 "check" : [
4609 "admin"
4610 ]
4611 },
4612 "protected" : 1,
4613 "returns" : {
4614 "type" : "null"
4615 }
4616 }
4617 },
4618 "leaf" : 0,
4619 "path" : "/config/ruledb",
4620 "text" : "ruledb"
4621 },
4622 {
4623 "children" : [
4624 {
4625 "children" : [
4626 {
4627 "info" : {
4628 "DELETE" : {
4629 "allowtoken" : 1,
4630 "description" : "Remove an object from the SMTP whitelist.",
4631 "method" : "DELETE",
4632 "name" : "delete_object",
4633 "parameters" : {
4634 "additionalProperties" : 0,
4635 "properties" : {
4636 "id" : {
4637 "description" : "Object ID.",
4638 "type" : "integer",
4639 "typetext" : "<integer>"
4640 }
4641 }
4642 },
4643 "permissions" : {
4644 "check" : [
4645 "admin"
4646 ]
4647 },
4648 "protected" : 1,
4649 "proxyto" : "master",
4650 "returns" : {
4651 "type" : "null"
4652 }
4653 }
4654 },
4655 "leaf" : 1,
4656 "path" : "/config/whitelist/objects/{id}",
4657 "text" : "{id}"
4658 }
4659 ],
4660 "info" : {
4661 "GET" : {
4662 "allowtoken" : 1,
4663 "description" : "Get list of all SMTP whitelist entries.",
4664 "method" : "GET",
4665 "name" : "objects",
4666 "parameters" : {
4667 "additionalProperties" : 0
4668 },
4669 "permissions" : {
4670 "check" : [
4671 "admin",
4672 "audit"
4673 ]
4674 },
4675 "proxyto" : "master",
4676 "returns" : {
4677 "items" : {
4678 "properties" : {
4679 "id" : {
4680 "type" : "integer"
4681 }
4682 },
4683 "type" : "object"
4684 },
4685 "links" : [
4686 {
4687 "href" : "{id}",
4688 "rel" : "child"
4689 }
4690 ],
4691 "type" : "array"
4692 }
4693 }
4694 },
4695 "leaf" : 0,
4696 "path" : "/config/whitelist/objects",
4697 "text" : "objects"
4698 },
4699 {
4700 "children" : [
4701 {
4702 "info" : {
4703 "GET" : {
4704 "allowtoken" : 1,
4705 "description" : "Read 'Mail address' object settings.",
4706 "method" : "GET",
4707 "name" : "read_email",
4708 "parameters" : {
4709 "additionalProperties" : 0,
4710 "properties" : {
4711 "id" : {
4712 "description" : "Object ID.",
4713 "type" : "integer",
4714 "typetext" : "<integer>"
4715 }
4716 }
4717 },
4718 "permissions" : {
4719 "check" : [
4720 "admin",
4721 "audit"
4722 ]
4723 },
4724 "proxyto" : "master",
4725 "returns" : {
4726 "properties" : {
4727 "id" : {
4728 "type" : "integer"
4729 }
4730 },
4731 "type" : "object"
4732 }
4733 },
4734 "PUT" : {
4735 "allowtoken" : 1,
4736 "description" : "Update 'Mail address' object.",
4737 "method" : "PUT",
4738 "name" : "update_email",
4739 "parameters" : {
4740 "additionalProperties" : 0,
4741 "properties" : {
4742 "email" : {
4743 "description" : "Email address.",
4744 "format" : "email",
4745 "type" : "string",
4746 "typetext" : "<string>"
4747 },
4748 "id" : {
4749 "description" : "Object ID.",
4750 "type" : "integer",
4751 "typetext" : "<integer>"
4752 }
4753 }
4754 },
4755 "permissions" : {
4756 "check" : [
4757 "admin"
4758 ]
4759 },
4760 "protected" : 1,
4761 "proxyto" : "master",
4762 "returns" : {
4763 "type" : "null"
4764 }
4765 }
4766 },
4767 "leaf" : 1,
4768 "path" : "/config/whitelist/email/{id}",
4769 "text" : "{id}"
4770 }
4771 ],
4772 "info" : {
4773 "POST" : {
4774 "allowtoken" : 1,
4775 "description" : "Add 'Mail address' object.",
4776 "method" : "POST",
4777 "name" : "email",
4778 "parameters" : {
4779 "additionalProperties" : 0,
4780 "properties" : {
4781 "email" : {
4782 "description" : "Email address.",
4783 "format" : "email",
4784 "type" : "string",
4785 "typetext" : "<string>"
4786 }
4787 }
4788 },
4789 "permissions" : {
4790 "check" : [
4791 "admin"
4792 ]
4793 },
4794 "protected" : 1,
4795 "proxyto" : "master",
4796 "returns" : {
4797 "description" : "The object ID.",
4798 "type" : "integer"
4799 }
4800 }
4801 },
4802 "leaf" : 0,
4803 "path" : "/config/whitelist/email",
4804 "text" : "email"
4805 },
4806 {
4807 "children" : [
4808 {
4809 "info" : {
4810 "GET" : {
4811 "allowtoken" : 1,
4812 "description" : "Read 'Mail address' object settings.",
4813 "method" : "GET",
4814 "name" : "read_receiver",
4815 "parameters" : {
4816 "additionalProperties" : 0,
4817 "properties" : {
4818 "id" : {
4819 "description" : "Object ID.",
4820 "type" : "integer",
4821 "typetext" : "<integer>"
4822 }
4823 }
4824 },
4825 "permissions" : {
4826 "check" : [
4827 "admin",
4828 "audit"
4829 ]
4830 },
4831 "proxyto" : "master",
4832 "returns" : {
4833 "properties" : {
4834 "id" : {
4835 "type" : "integer"
4836 }
4837 },
4838 "type" : "object"
4839 }
4840 },
4841 "PUT" : {
4842 "allowtoken" : 1,
4843 "description" : "Update 'Mail address' object.",
4844 "method" : "PUT",
4845 "name" : "update_receiver",
4846 "parameters" : {
4847 "additionalProperties" : 0,
4848 "properties" : {
4849 "email" : {
4850 "description" : "Email address.",
4851 "format" : "email",
4852 "type" : "string",
4853 "typetext" : "<string>"
4854 },
4855 "id" : {
4856 "description" : "Object ID.",
4857 "type" : "integer",
4858 "typetext" : "<integer>"
4859 }
4860 }
4861 },
4862 "permissions" : {
4863 "check" : [
4864 "admin"
4865 ]
4866 },
4867 "protected" : 1,
4868 "proxyto" : "master",
4869 "returns" : {
4870 "type" : "null"
4871 }
4872 }
4873 },
4874 "leaf" : 1,
4875 "path" : "/config/whitelist/receiver/{id}",
4876 "text" : "{id}"
4877 }
4878 ],
4879 "info" : {
4880 "POST" : {
4881 "allowtoken" : 1,
4882 "description" : "Add 'Mail address' object.",
4883 "method" : "POST",
4884 "name" : "receiver",
4885 "parameters" : {
4886 "additionalProperties" : 0,
4887 "properties" : {
4888 "email" : {
4889 "description" : "Email address.",
4890 "format" : "email",
4891 "type" : "string",
4892 "typetext" : "<string>"
4893 }
4894 }
4895 },
4896 "permissions" : {
4897 "check" : [
4898 "admin"
4899 ]
4900 },
4901 "protected" : 1,
4902 "proxyto" : "master",
4903 "returns" : {
4904 "description" : "The object ID.",
4905 "type" : "integer"
4906 }
4907 }
4908 },
4909 "leaf" : 0,
4910 "path" : "/config/whitelist/receiver",
4911 "text" : "receiver"
4912 },
4913 {
4914 "children" : [
4915 {
4916 "info" : {
4917 "GET" : {
4918 "allowtoken" : 1,
4919 "description" : "Read 'Domain' object settings.",
4920 "method" : "GET",
4921 "name" : "read_domain",
4922 "parameters" : {
4923 "additionalProperties" : 0,
4924 "properties" : {
4925 "id" : {
4926 "description" : "Object ID.",
4927 "type" : "integer",
4928 "typetext" : "<integer>"
4929 }
4930 }
4931 },
4932 "permissions" : {
4933 "check" : [
4934 "admin",
4935 "audit"
4936 ]
4937 },
4938 "proxyto" : "master",
4939 "returns" : {
4940 "properties" : {
4941 "id" : {
4942 "type" : "integer"
4943 }
4944 },
4945 "type" : "object"
4946 }
4947 },
4948 "PUT" : {
4949 "allowtoken" : 1,
4950 "description" : "Update 'Domain' object.",
4951 "method" : "PUT",
4952 "name" : "update_domain",
4953 "parameters" : {
4954 "additionalProperties" : 0,
4955 "properties" : {
4956 "domain" : {
4957 "description" : "DNS domain name (Sender).",
4958 "format" : "dns-name",
4959 "type" : "string",
4960 "typetext" : "<string>"
4961 },
4962 "id" : {
4963 "description" : "Object ID.",
4964 "type" : "integer",
4965 "typetext" : "<integer>"
4966 }
4967 }
4968 },
4969 "permissions" : {
4970 "check" : [
4971 "admin"
4972 ]
4973 },
4974 "protected" : 1,
4975 "proxyto" : "master",
4976 "returns" : {
4977 "type" : "null"
4978 }
4979 }
4980 },
4981 "leaf" : 1,
4982 "path" : "/config/whitelist/domain/{id}",
4983 "text" : "{id}"
4984 }
4985 ],
4986 "info" : {
4987 "POST" : {
4988 "allowtoken" : 1,
4989 "description" : "Add 'Domain' object.",
4990 "method" : "POST",
4991 "name" : "domain",
4992 "parameters" : {
4993 "additionalProperties" : 0,
4994 "properties" : {
4995 "domain" : {
4996 "description" : "DNS domain name (Sender).",
4997 "format" : "dns-name",
4998 "type" : "string",
4999 "typetext" : "<string>"
5000 }
5001 }
5002 },
5003 "permissions" : {
5004 "check" : [
5005 "admin"
5006 ]
5007 },
5008 "protected" : 1,
5009 "proxyto" : "master",
5010 "returns" : {
5011 "description" : "The object ID.",
5012 "type" : "integer"
5013 }
5014 }
5015 },
5016 "leaf" : 0,
5017 "path" : "/config/whitelist/domain",
5018 "text" : "domain"
5019 },
5020 {
5021 "children" : [
5022 {
5023 "info" : {
5024 "GET" : {
5025 "allowtoken" : 1,
5026 "description" : "Read 'Domain' object settings.",
5027 "method" : "GET",
5028 "name" : "read_receiver_domain",
5029 "parameters" : {
5030 "additionalProperties" : 0,
5031 "properties" : {
5032 "id" : {
5033 "description" : "Object ID.",
5034 "type" : "integer",
5035 "typetext" : "<integer>"
5036 }
5037 }
5038 },
5039 "permissions" : {
5040 "check" : [
5041 "admin",
5042 "audit"
5043 ]
5044 },
5045 "proxyto" : "master",
5046 "returns" : {
5047 "properties" : {
5048 "id" : {
5049 "type" : "integer"
5050 }
5051 },
5052 "type" : "object"
5053 }
5054 },
5055 "PUT" : {
5056 "allowtoken" : 1,
5057 "description" : "Update 'Domain' object.",
5058 "method" : "PUT",
5059 "name" : "update_receiver_domain",
5060 "parameters" : {
5061 "additionalProperties" : 0,
5062 "properties" : {
5063 "domain" : {
5064 "description" : "DNS domain name (Sender).",
5065 "format" : "dns-name",
5066 "type" : "string",
5067 "typetext" : "<string>"
5068 },
5069 "id" : {
5070 "description" : "Object ID.",
5071 "type" : "integer",
5072 "typetext" : "<integer>"
5073 }
5074 }
5075 },
5076 "permissions" : {
5077 "check" : [
5078 "admin"
5079 ]
5080 },
5081 "protected" : 1,
5082 "proxyto" : "master",
5083 "returns" : {
5084 "type" : "null"
5085 }
5086 }
5087 },
5088 "leaf" : 1,
5089 "path" : "/config/whitelist/receiver_domain/{id}",
5090 "text" : "{id}"
5091 }
5092 ],
5093 "info" : {
5094 "POST" : {
5095 "allowtoken" : 1,
5096 "description" : "Add 'Domain' object.",
5097 "method" : "POST",
5098 "name" : "receiver_domain",
5099 "parameters" : {
5100 "additionalProperties" : 0,
5101 "properties" : {
5102 "domain" : {
5103 "description" : "DNS domain name (Sender).",
5104 "format" : "dns-name",
5105 "type" : "string",
5106 "typetext" : "<string>"
5107 }
5108 }
5109 },
5110 "permissions" : {
5111 "check" : [
5112 "admin"
5113 ]
5114 },
5115 "protected" : 1,
5116 "proxyto" : "master",
5117 "returns" : {
5118 "description" : "The object ID.",
5119 "type" : "integer"
5120 }
5121 }
5122 },
5123 "leaf" : 0,
5124 "path" : "/config/whitelist/receiver_domain",
5125 "text" : "receiver_domain"
5126 },
5127 {
5128 "children" : [
5129 {
5130 "info" : {
5131 "GET" : {
5132 "allowtoken" : 1,
5133 "description" : "Read 'Regular Expression' object settings.",
5134 "method" : "GET",
5135 "name" : "read_regex",
5136 "parameters" : {
5137 "additionalProperties" : 0,
5138 "properties" : {
5139 "id" : {
5140 "description" : "Object ID.",
5141 "type" : "integer",
5142 "typetext" : "<integer>"
5143 }
5144 }
5145 },
5146 "permissions" : {
5147 "check" : [
5148 "admin",
5149 "audit"
5150 ]
5151 },
5152 "proxyto" : "master",
5153 "returns" : {
5154 "properties" : {
5155 "id" : {
5156 "type" : "integer"
5157 }
5158 },
5159 "type" : "object"
5160 }
5161 },
5162 "PUT" : {
5163 "allowtoken" : 1,
5164 "description" : "Update 'Regular Expression' object.",
5165 "method" : "PUT",
5166 "name" : "update_regex",
5167 "parameters" : {
5168 "additionalProperties" : 0,
5169 "properties" : {
5170 "id" : {
5171 "description" : "Object ID.",
5172 "type" : "integer",
5173 "typetext" : "<integer>"
5174 },
5175 "regex" : {
5176 "description" : "Email address regular expression.",
5177 "maxLength" : 1024,
5178 "type" : "string",
5179 "typetext" : "<string>"
5180 }
5181 }
5182 },
5183 "permissions" : {
5184 "check" : [
5185 "admin"
5186 ]
5187 },
5188 "protected" : 1,
5189 "proxyto" : "master",
5190 "returns" : {
5191 "type" : "null"
5192 }
5193 }
5194 },
5195 "leaf" : 1,
5196 "path" : "/config/whitelist/regex/{id}",
5197 "text" : "{id}"
5198 }
5199 ],
5200 "info" : {
5201 "POST" : {
5202 "allowtoken" : 1,
5203 "description" : "Add 'Regular Expression' object.",
5204 "method" : "POST",
5205 "name" : "regex",
5206 "parameters" : {
5207 "additionalProperties" : 0,
5208 "properties" : {
5209 "regex" : {
5210 "description" : "Email address regular expression.",
5211 "maxLength" : 1024,
5212 "type" : "string",
5213 "typetext" : "<string>"
5214 }
5215 }
5216 },
5217 "permissions" : {
5218 "check" : [
5219 "admin"
5220 ]
5221 },
5222 "protected" : 1,
5223 "proxyto" : "master",
5224 "returns" : {
5225 "description" : "The object ID.",
5226 "type" : "integer"
5227 }
5228 }
5229 },
5230 "leaf" : 0,
5231 "path" : "/config/whitelist/regex",
5232 "text" : "regex"
5233 },
5234 {
5235 "children" : [
5236 {
5237 "info" : {
5238 "GET" : {
5239 "allowtoken" : 1,
5240 "description" : "Read 'Regular Expression' object settings.",
5241 "method" : "GET",
5242 "name" : "read_receiver_regex",
5243 "parameters" : {
5244 "additionalProperties" : 0,
5245 "properties" : {
5246 "id" : {
5247 "description" : "Object ID.",
5248 "type" : "integer",
5249 "typetext" : "<integer>"
5250 }
5251 }
5252 },
5253 "permissions" : {
5254 "check" : [
5255 "admin",
5256 "audit"
5257 ]
5258 },
5259 "proxyto" : "master",
5260 "returns" : {
5261 "properties" : {
5262 "id" : {
5263 "type" : "integer"
5264 }
5265 },
5266 "type" : "object"
5267 }
5268 },
5269 "PUT" : {
5270 "allowtoken" : 1,
5271 "description" : "Update 'Regular Expression' object.",
5272 "method" : "PUT",
5273 "name" : "update_receiver_regex",
5274 "parameters" : {
5275 "additionalProperties" : 0,
5276 "properties" : {
5277 "id" : {
5278 "description" : "Object ID.",
5279 "type" : "integer",
5280 "typetext" : "<integer>"
5281 },
5282 "regex" : {
5283 "description" : "Email address regular expression.",
5284 "maxLength" : 1024,
5285 "type" : "string",
5286 "typetext" : "<string>"
5287 }
5288 }
5289 },
5290 "permissions" : {
5291 "check" : [
5292 "admin"
5293 ]
5294 },
5295 "protected" : 1,
5296 "proxyto" : "master",
5297 "returns" : {
5298 "type" : "null"
5299 }
5300 }
5301 },
5302 "leaf" : 1,
5303 "path" : "/config/whitelist/receiver_regex/{id}",
5304 "text" : "{id}"
5305 }
5306 ],
5307 "info" : {
5308 "POST" : {
5309 "allowtoken" : 1,
5310 "description" : "Add 'Regular Expression' object.",
5311 "method" : "POST",
5312 "name" : "receiver_regex",
5313 "parameters" : {
5314 "additionalProperties" : 0,
5315 "properties" : {
5316 "regex" : {
5317 "description" : "Email address regular expression.",
5318 "maxLength" : 1024,
5319 "type" : "string",
5320 "typetext" : "<string>"
5321 }
5322 }
5323 },
5324 "permissions" : {
5325 "check" : [
5326 "admin"
5327 ]
5328 },
5329 "protected" : 1,
5330 "proxyto" : "master",
5331 "returns" : {
5332 "description" : "The object ID.",
5333 "type" : "integer"
5334 }
5335 }
5336 },
5337 "leaf" : 0,
5338 "path" : "/config/whitelist/receiver_regex",
5339 "text" : "receiver_regex"
5340 },
5341 {
5342 "children" : [
5343 {
5344 "info" : {
5345 "GET" : {
5346 "allowtoken" : 1,
5347 "description" : "Read 'IP Address' object settings.",
5348 "method" : "GET",
5349 "name" : "read_ip",
5350 "parameters" : {
5351 "additionalProperties" : 0,
5352 "properties" : {
5353 "id" : {
5354 "description" : "Object ID.",
5355 "type" : "integer",
5356 "typetext" : "<integer>"
5357 }
5358 }
5359 },
5360 "permissions" : {
5361 "check" : [
5362 "admin",
5363 "audit"
5364 ]
5365 },
5366 "proxyto" : "master",
5367 "returns" : {
5368 "properties" : {
5369 "id" : {
5370 "type" : "integer"
5371 }
5372 },
5373 "type" : "object"
5374 }
5375 },
5376 "PUT" : {
5377 "allowtoken" : 1,
5378 "description" : "Update 'IP Address' object.",
5379 "method" : "PUT",
5380 "name" : "update_ip",
5381 "parameters" : {
5382 "additionalProperties" : 0,
5383 "properties" : {
5384 "id" : {
5385 "description" : "Object ID.",
5386 "type" : "integer",
5387 "typetext" : "<integer>"
5388 },
5389 "ip" : {
5390 "description" : "IP address",
5391 "format" : "ip",
5392 "type" : "string",
5393 "typetext" : "<string>"
5394 }
5395 }
5396 },
5397 "permissions" : {
5398 "check" : [
5399 "admin"
5400 ]
5401 },
5402 "protected" : 1,
5403 "proxyto" : "master",
5404 "returns" : {
5405 "type" : "null"
5406 }
5407 }
5408 },
5409 "leaf" : 1,
5410 "path" : "/config/whitelist/ip/{id}",
5411 "text" : "{id}"
5412 }
5413 ],
5414 "info" : {
5415 "POST" : {
5416 "allowtoken" : 1,
5417 "description" : "Add 'IP Address' object.",
5418 "method" : "POST",
5419 "name" : "ip",
5420 "parameters" : {
5421 "additionalProperties" : 0,
5422 "properties" : {
5423 "ip" : {
5424 "description" : "IP address",
5425 "format" : "ip",
5426 "type" : "string",
5427 "typetext" : "<string>"
5428 }
5429 }
5430 },
5431 "permissions" : {
5432 "check" : [
5433 "admin"
5434 ]
5435 },
5436 "protected" : 1,
5437 "proxyto" : "master",
5438 "returns" : {
5439 "description" : "The object ID.",
5440 "type" : "integer"
5441 }
5442 }
5443 },
5444 "leaf" : 0,
5445 "path" : "/config/whitelist/ip",
5446 "text" : "ip"
5447 },
5448 {
5449 "children" : [
5450 {
5451 "info" : {
5452 "GET" : {
5453 "allowtoken" : 1,
5454 "description" : "Read 'IP Network' object settings.",
5455 "method" : "GET",
5456 "name" : "read_network",
5457 "parameters" : {
5458 "additionalProperties" : 0,
5459 "properties" : {
5460 "id" : {
5461 "description" : "Object ID.",
5462 "type" : "integer",
5463 "typetext" : "<integer>"
5464 }
5465 }
5466 },
5467 "permissions" : {
5468 "check" : [
5469 "admin",
5470 "audit"
5471 ]
5472 },
5473 "proxyto" : "master",
5474 "returns" : {
5475 "properties" : {
5476 "id" : {
5477 "type" : "integer"
5478 }
5479 },
5480 "type" : "object"
5481 }
5482 },
5483 "PUT" : {
5484 "allowtoken" : 1,
5485 "description" : "Update 'IP Network' object.",
5486 "method" : "PUT",
5487 "name" : "update_network",
5488 "parameters" : {
5489 "additionalProperties" : 0,
5490 "properties" : {
5491 "cidr" : {
5492 "description" : "Network address in CIDR notation.",
5493 "format" : "CIDR",
5494 "type" : "string",
5495 "typetext" : "<string>"
5496 },
5497 "id" : {
5498 "description" : "Object ID.",
5499 "type" : "integer",
5500 "typetext" : "<integer>"
5501 }
5502 }
5503 },
5504 "permissions" : {
5505 "check" : [
5506 "admin"
5507 ]
5508 },
5509 "protected" : 1,
5510 "proxyto" : "master",
5511 "returns" : {
5512 "type" : "null"
5513 }
5514 }
5515 },
5516 "leaf" : 1,
5517 "path" : "/config/whitelist/network/{id}",
5518 "text" : "{id}"
5519 }
5520 ],
5521 "info" : {
5522 "POST" : {
5523 "allowtoken" : 1,
5524 "description" : "Add 'IP Network' object.",
5525 "method" : "POST",
5526 "name" : "network",
5527 "parameters" : {
5528 "additionalProperties" : 0,
5529 "properties" : {
5530 "cidr" : {
5531 "description" : "Network address in CIDR notation.",
5532 "format" : "CIDR",
5533 "type" : "string",
5534 "typetext" : "<string>"
5535 }
5536 }
5537 },
5538 "permissions" : {
5539 "check" : [
5540 "admin"
5541 ]
5542 },
5543 "protected" : 1,
5544 "proxyto" : "master",
5545 "returns" : {
5546 "description" : "The object ID.",
5547 "type" : "integer"
5548 }
5549 }
5550 },
5551 "leaf" : 0,
5552 "path" : "/config/whitelist/network",
5553 "text" : "network"
5554 }
5555 ],
5556 "info" : {
5557 "GET" : {
5558 "allowtoken" : 1,
5559 "description" : "Directory index.",
5560 "method" : "GET",
5561 "name" : "index",
5562 "parameters" : {
5563 "additionalProperties" : 0
5564 },
5565 "permissions" : {
5566 "check" : [
5567 "admin",
5568 "audit"
5569 ]
5570 },
5571 "returns" : {
5572 "items" : {
5573 "properties" : {
5574 "subdir" : {
5575 "type" : "string"
5576 }
5577 },
5578 "type" : "object"
5579 },
5580 "links" : [
5581 {
5582 "href" : "{subdir}",
5583 "rel" : "child"
5584 }
5585 ],
5586 "type" : "array"
5587 }
5588 }
5589 },
5590 "leaf" : 0,
5591 "path" : "/config/whitelist",
5592 "text" : "whitelist"
5593 },
5594 {
5595 "children" : [
5596 {
5597 "children" : [
5598 {
5599 "info" : {
5600 "GET" : {
5601 "allowtoken" : 1,
5602 "description" : "Get LDAP profile configuration.",
5603 "method" : "GET",
5604 "name" : "read_config",
5605 "parameters" : {
5606 "additionalProperties" : 0,
5607 "properties" : {
5608 "profile" : {
5609 "description" : "Profile ID.",
5610 "format" : "pve-configid",
5611 "type" : "string",
5612 "typetext" : "<string>"
5613 }
5614 }
5615 },
5616 "permissions" : {
5617 "check" : [
5618 "admin",
5619 "audit"
5620 ]
5621 },
5622 "proxyto" : "master",
5623 "returns" : {}
5624 },
5625 "PUT" : {
5626 "allowtoken" : 1,
5627 "description" : "Update LDAP profile settings.",
5628 "method" : "PUT",
5629 "name" : "update_config",
5630 "parameters" : {
5631 "additionalProperties" : 0,
5632 "properties" : {
5633 "accountattr" : {
5634 "default" : "sAMAccountName, uid",
5635 "description" : "Account attribute name name.",
5636 "format" : "ldap-simple-attr-list",
5637 "optional" : 1,
5638 "type" : "string",
5639 "typetext" : "<string>"
5640 },
5641 "basedn" : {
5642 "description" : "Base domain name.",
5643 "optional" : 1,
5644 "type" : "string",
5645 "typetext" : "<string>"
5646 },
5647 "binddn" : {
5648 "description" : "Bind domain name.",
5649 "optional" : 1,
5650 "type" : "string",
5651 "typetext" : "<string>"
5652 },
5653 "bindpw" : {
5654 "description" : "Bind password.",
5655 "optional" : 1,
5656 "type" : "string",
5657 "typetext" : "<string>"
5658 },
5659 "cafile" : {
5660 "description" : "Path to CA file. Only useful with option 'verify'",
5661 "optional" : 1,
5662 "type" : "string",
5663 "typetext" : "<string>"
5664 },
5665 "comment" : {
5666 "description" : "Description.",
5667 "maxLength" : 4096,
5668 "optional" : 1,
5669 "type" : "string",
5670 "typetext" : "<string>"
5671 },
5672 "delete" : {
5673 "description" : "A list of settings you want to delete.",
5674 "format" : "pve-configid-list",
5675 "maxLength" : 4096,
5676 "optional" : 1,
5677 "type" : "string",
5678 "typetext" : "<string>"
5679 },
5680 "digest" : {
5681 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
5682 "maxLength" : 40,
5683 "optional" : 1,
5684 "type" : "string",
5685 "typetext" : "<string>"
5686 },
5687 "disable" : {
5688 "description" : "Flag to disable/deactivate the entry.",
5689 "optional" : 1,
5690 "type" : "boolean",
5691 "typetext" : "<boolean>"
5692 },
5693 "filter" : {
5694 "description" : "LDAP filter.",
5695 "optional" : 1,
5696 "type" : "string",
5697 "typetext" : "<string>"
5698 },
5699 "groupbasedn" : {
5700 "description" : "Base domain name for groups.",
5701 "optional" : 1,
5702 "type" : "string",
5703 "typetext" : "<string>"
5704 },
5705 "groupclass" : {
5706 "default" : "group, univentionGroup, ipausergroup",
5707 "description" : "List of objectclasses for groups.",
5708 "format" : "ldap-simple-attr-list",
5709 "optional" : 1,
5710 "type" : "string",
5711 "typetext" : "<string>"
5712 },
5713 "mailattr" : {
5714 "default" : "mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress",
5715 "description" : "List of mail attribute names.",
5716 "format" : "ldap-simple-attr-list",
5717 "optional" : 1,
5718 "type" : "string",
5719 "typetext" : "<string>"
5720 },
5721 "mode" : {
5722 "default" : "ldap",
5723 "description" : "LDAP protocol mode ('ldap', 'ldaps' or 'ldap+starttls').",
5724 "enum" : [
5725 "ldap",
5726 "ldaps",
5727 "ldap+starttls"
5728 ],
5729 "optional" : 1,
5730 "type" : "string"
5731 },
5732 "port" : {
5733 "description" : "Specify the port to connect to.",
5734 "maximum" : 65535,
5735 "minimum" : 1,
5736 "optional" : 1,
5737 "type" : "integer",
5738 "typetext" : "<integer> (1 - 65535)"
5739 },
5740 "profile" : {
5741 "description" : "Profile ID.",
5742 "format" : "pve-configid",
5743 "type" : "string",
5744 "typetext" : "<string>"
5745 },
5746 "server1" : {
5747 "description" : "Server address.",
5748 "format" : "address",
5749 "maxLength" : 256,
5750 "optional" : 1,
5751 "type" : "string",
5752 "typetext" : "<string>"
5753 },
5754 "server2" : {
5755 "description" : "Fallback server address. Userd when the first server is not available.",
5756 "format" : "address",
5757 "maxLength" : 256,
5758 "optional" : 1,
5759 "type" : "string",
5760 "typetext" : "<string>"
5761 },
5762 "verify" : {
5763 "default" : 0,
5764 "description" : "Verify server certificate. Only useful with ldaps or ldap+starttls.",
5765 "optional" : 1,
5766 "type" : "boolean",
5767 "typetext" : "<boolean>"
5768 }
5769 },
5770 "type" : "object"
5771 },
5772 "permissions" : {
5773 "check" : [
5774 "admin"
5775 ]
5776 },
5777 "protected" : 1,
5778 "proxyto" : "master",
5779 "returns" : {
5780 "type" : "null"
5781 }
5782 }
5783 },
5784 "leaf" : 1,
5785 "path" : "/config/ldap/{profile}/config",
5786 "text" : "config"
5787 },
5788 {
5789 "info" : {
5790 "POST" : {
5791 "allowtoken" : 1,
5792 "description" : "Synchronice LDAP users to local database.",
5793 "method" : "POST",
5794 "name" : "sync_profile",
5795 "parameters" : {
5796 "additionalProperties" : 0,
5797 "properties" : {
5798 "profile" : {
5799 "description" : "Profile ID.",
5800 "format" : "pve-configid",
5801 "type" : "string",
5802 "typetext" : "<string>"
5803 }
5804 }
5805 },
5806 "permissions" : {
5807 "check" : [
5808 "admin"
5809 ]
5810 },
5811 "protected" : 1,
5812 "proxyto" : "master",
5813 "returns" : {
5814 "type" : "null"
5815 }
5816 }
5817 },
5818 "leaf" : 1,
5819 "path" : "/config/ldap/{profile}/sync",
5820 "text" : "sync"
5821 },
5822 {
5823 "children" : [
5824 {
5825 "info" : {
5826 "GET" : {
5827 "allowtoken" : 1,
5828 "description" : "Get all email addresses for the specified user.",
5829 "method" : "GET",
5830 "name" : "address_list",
5831 "parameters" : {
5832 "additionalProperties" : 0,
5833 "properties" : {
5834 "email" : {
5835 "description" : "Email address.",
5836 "format" : "email",
5837 "type" : "string",
5838 "typetext" : "<string>"
5839 },
5840 "profile" : {
5841 "description" : "Profile ID.",
5842 "format" : "pve-configid",
5843 "type" : "string",
5844 "typetext" : "<string>"
5845 }
5846 }
5847 },
5848 "permissions" : {
5849 "check" : [
5850 "admin",
5851 "audit"
5852 ]
5853 },
5854 "protected" : 1,
5855 "proxyto" : "master",
5856 "returns" : {
5857 "items" : {
5858 "properties" : {
5859 "email" : {
5860 "type" : "string"
5861 },
5862 "primary" : {
5863 "type" : "boolean"
5864 }
5865 },
5866 "type" : "object"
5867 },
5868 "type" : "array"
5869 }
5870 }
5871 },
5872 "leaf" : 1,
5873 "path" : "/config/ldap/{profile}/users/{email}",
5874 "text" : "{email}"
5875 }
5876 ],
5877 "info" : {
5878 "GET" : {
5879 "allowtoken" : 1,
5880 "description" : "List LDAP users.",
5881 "method" : "GET",
5882 "name" : "profile_list_users",
5883 "parameters" : {
5884 "additionalProperties" : 0,
5885 "properties" : {
5886 "profile" : {
5887 "description" : "Profile ID.",
5888 "format" : "pve-configid",
5889 "type" : "string",
5890 "typetext" : "<string>"
5891 }
5892 }
5893 },
5894 "permissions" : {
5895 "check" : [
5896 "admin",
5897 "audit"
5898 ]
5899 },
5900 "protected" : 1,
5901 "proxyto" : "master",
5902 "returns" : {
5903 "items" : {
5904 "properties" : {
5905 "account" : {
5906 "type" : "string"
5907 },
5908 "dn" : {
5909 "type" : "string"
5910 },
5911 "pmail" : {
5912 "type" : "string"
5913 }
5914 },
5915 "type" : "object"
5916 },
5917 "links" : [
5918 {
5919 "href" : "{pmail}",
5920 "rel" : "child"
5921 }
5922 ],
5923 "type" : "array"
5924 }
5925 }
5926 },
5927 "leaf" : 0,
5928 "path" : "/config/ldap/{profile}/users",
5929 "text" : "users"
5930 },
5931 {
5932 "children" : [
5933 {
5934 "info" : {
5935 "GET" : {
5936 "allowtoken" : 1,
5937 "description" : "List LDAP group members.",
5938 "method" : "GET",
5939 "name" : "profile_list_group_members",
5940 "parameters" : {
5941 "additionalProperties" : 0,
5942 "properties" : {
5943 "gid" : {
5944 "description" : "Group ID",
5945 "type" : "number",
5946 "typetext" : "<number>"
5947 },
5948 "profile" : {
5949 "description" : "Profile ID.",
5950 "format" : "pve-configid",
5951 "type" : "string",
5952 "typetext" : "<string>"
5953 }
5954 }
5955 },
5956 "permissions" : {
5957 "check" : [
5958 "admin",
5959 "audit"
5960 ]
5961 },
5962 "protected" : 1,
5963 "proxyto" : "master",
5964 "returns" : {
5965 "items" : {
5966 "properties" : {
5967 "account" : {
5968 "type" : "string"
5969 },
5970 "dn" : {
5971 "type" : "string"
5972 },
5973 "pmail" : {
5974 "type" : "string"
5975 }
5976 },
5977 "type" : "object"
5978 },
5979 "type" : "array"
5980 }
5981 }
5982 },
5983 "leaf" : 1,
5984 "path" : "/config/ldap/{profile}/groups/{gid}",
5985 "text" : "{gid}"
5986 }
5987 ],
5988 "info" : {
5989 "GET" : {
5990 "allowtoken" : 1,
5991 "description" : "List LDAP groups.",
5992 "method" : "GET",
5993 "name" : "profile_list_groups",
5994 "parameters" : {
5995 "additionalProperties" : 0,
5996 "properties" : {
5997 "profile" : {
5998 "description" : "Profile ID.",
5999 "format" : "pve-configid",
6000 "type" : "string",
6001 "typetext" : "<string>"
6002 }
6003 }
6004 },
6005 "permissions" : {
6006 "check" : [
6007 "admin",
6008 "audit"
6009 ]
6010 },
6011 "protected" : 1,
6012 "proxyto" : "master",
6013 "returns" : {
6014 "items" : {
6015 "properties" : {
6016 "dn" : {
6017 "type" : "string"
6018 },
6019 "gid" : {
6020 "type" : "number"
6021 }
6022 },
6023 "type" : "object"
6024 },
6025 "links" : [
6026 {
6027 "href" : "{gid}",
6028 "rel" : "child"
6029 }
6030 ],
6031 "type" : "array"
6032 }
6033 }
6034 },
6035 "leaf" : 0,
6036 "path" : "/config/ldap/{profile}/groups",
6037 "text" : "groups"
6038 }
6039 ],
6040 "info" : {
6041 "DELETE" : {
6042 "allowtoken" : 1,
6043 "description" : "Delete an LDAP profile",
6044 "method" : "DELETE",
6045 "name" : "delete",
6046 "parameters" : {
6047 "additionalProperties" : 0,
6048 "properties" : {
6049 "profile" : {
6050 "description" : "Profile ID.",
6051 "format" : "pve-configid",
6052 "type" : "string",
6053 "typetext" : "<string>"
6054 }
6055 }
6056 },
6057 "permissions" : {
6058 "check" : [
6059 "admin"
6060 ]
6061 },
6062 "protected" : 1,
6063 "proxyto" : "master",
6064 "returns" : {
6065 "type" : "null"
6066 }
6067 },
6068 "GET" : {
6069 "allowtoken" : 1,
6070 "description" : "Directory index",
6071 "method" : "GET",
6072 "name" : "profile_index",
6073 "parameters" : {
6074 "additionalProperties" : 0,
6075 "properties" : {
6076 "profile" : {
6077 "description" : "Profile ID.",
6078 "format" : "pve-configid",
6079 "type" : "string",
6080 "typetext" : "<string>"
6081 }
6082 }
6083 },
6084 "permissions" : {
6085 "user" : "all"
6086 },
6087 "returns" : {
6088 "items" : {
6089 "properties" : {
6090 "subdir" : {
6091 "type" : "string"
6092 }
6093 },
6094 "type" : "object"
6095 },
6096 "links" : [
6097 {
6098 "href" : "{subdir}",
6099 "rel" : "child"
6100 }
6101 ],
6102 "type" : "array"
6103 }
6104 }
6105 },
6106 "leaf" : 0,
6107 "path" : "/config/ldap/{profile}",
6108 "text" : "{profile}"
6109 }
6110 ],
6111 "info" : {
6112 "GET" : {
6113 "allowtoken" : 1,
6114 "description" : "List configured LDAP profiles.",
6115 "method" : "GET",
6116 "name" : "index",
6117 "parameters" : {
6118 "additionalProperties" : 0
6119 },
6120 "permissions" : {
6121 "check" : [
6122 "admin",
6123 "audit"
6124 ]
6125 },
6126 "proxyto" : "master",
6127 "returns" : {
6128 "items" : {
6129 "properties" : {
6130 "comment" : {
6131 "optional" : 1,
6132 "type" : "string"
6133 },
6134 "disable" : {
6135 "type" : "boolean"
6136 },
6137 "gcount" : {
6138 "optional" : 1,
6139 "type" : "integer"
6140 },
6141 "mcount" : {
6142 "optional" : 1,
6143 "type" : "integer"
6144 },
6145 "mode" : {
6146 "type" : "string"
6147 },
6148 "profile" : {
6149 "type" : "string"
6150 },
6151 "server1" : {
6152 "type" : "string"
6153 },
6154 "server2" : {
6155 "optional" : 1,
6156 "type" : "string"
6157 },
6158 "ucount" : {
6159 "optional" : 1,
6160 "type" : "integer"
6161 }
6162 },
6163 "type" : "object"
6164 },
6165 "links" : [
6166 {
6167 "href" : "{profile}",
6168 "rel" : "child"
6169 }
6170 ],
6171 "type" : "array"
6172 }
6173 },
6174 "POST" : {
6175 "allowtoken" : 1,
6176 "description" : "Add LDAP profile.",
6177 "method" : "POST",
6178 "name" : "create",
6179 "parameters" : {
6180 "additionalProperties" : 0,
6181 "properties" : {
6182 "accountattr" : {
6183 "default" : "sAMAccountName, uid",
6184 "description" : "Account attribute name name.",
6185 "format" : "ldap-simple-attr-list",
6186 "optional" : 1,
6187 "type" : "string",
6188 "typetext" : "<string>"
6189 },
6190 "basedn" : {
6191 "description" : "Base domain name.",
6192 "optional" : 1,
6193 "type" : "string",
6194 "typetext" : "<string>"
6195 },
6196 "binddn" : {
6197 "description" : "Bind domain name.",
6198 "optional" : 1,
6199 "type" : "string",
6200 "typetext" : "<string>"
6201 },
6202 "bindpw" : {
6203 "description" : "Bind password.",
6204 "optional" : 1,
6205 "type" : "string",
6206 "typetext" : "<string>"
6207 },
6208 "cafile" : {
6209 "description" : "Path to CA file. Only useful with option 'verify'",
6210 "optional" : 1,
6211 "type" : "string",
6212 "typetext" : "<string>"
6213 },
6214 "comment" : {
6215 "description" : "Description.",
6216 "maxLength" : 4096,
6217 "optional" : 1,
6218 "type" : "string",
6219 "typetext" : "<string>"
6220 },
6221 "disable" : {
6222 "description" : "Flag to disable/deactivate the entry.",
6223 "optional" : 1,
6224 "type" : "boolean",
6225 "typetext" : "<boolean>"
6226 },
6227 "filter" : {
6228 "description" : "LDAP filter.",
6229 "optional" : 1,
6230 "type" : "string",
6231 "typetext" : "<string>"
6232 },
6233 "groupbasedn" : {
6234 "description" : "Base domain name for groups.",
6235 "optional" : 1,
6236 "type" : "string",
6237 "typetext" : "<string>"
6238 },
6239 "groupclass" : {
6240 "default" : "group, univentionGroup, ipausergroup",
6241 "description" : "List of objectclasses for groups.",
6242 "format" : "ldap-simple-attr-list",
6243 "optional" : 1,
6244 "type" : "string",
6245 "typetext" : "<string>"
6246 },
6247 "mailattr" : {
6248 "default" : "mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress",
6249 "description" : "List of mail attribute names.",
6250 "format" : "ldap-simple-attr-list",
6251 "optional" : 1,
6252 "type" : "string",
6253 "typetext" : "<string>"
6254 },
6255 "mode" : {
6256 "default" : "ldap",
6257 "description" : "LDAP protocol mode ('ldap', 'ldaps' or 'ldap+starttls').",
6258 "enum" : [
6259 "ldap",
6260 "ldaps",
6261 "ldap+starttls"
6262 ],
6263 "optional" : 1,
6264 "type" : "string"
6265 },
6266 "port" : {
6267 "description" : "Specify the port to connect to.",
6268 "maximum" : 65535,
6269 "minimum" : 1,
6270 "optional" : 1,
6271 "type" : "integer",
6272 "typetext" : "<integer> (1 - 65535)"
6273 },
6274 "profile" : {
6275 "description" : "Profile ID.",
6276 "format" : "pve-configid",
6277 "type" : "string",
6278 "typetext" : "<string>"
6279 },
6280 "server1" : {
6281 "description" : "Server address.",
6282 "format" : "address",
6283 "maxLength" : 256,
6284 "optional" : 0,
6285 "type" : "string",
6286 "typetext" : "<string>"
6287 },
6288 "server2" : {
6289 "description" : "Fallback server address. Userd when the first server is not available.",
6290 "format" : "address",
6291 "maxLength" : 256,
6292 "optional" : 1,
6293 "type" : "string",
6294 "typetext" : "<string>"
6295 },
6296 "verify" : {
6297 "default" : 0,
6298 "description" : "Verify server certificate. Only useful with ldaps or ldap+starttls.",
6299 "optional" : 1,
6300 "type" : "boolean",
6301 "typetext" : "<boolean>"
6302 }
6303 },
6304 "type" : "object"
6305 },
6306 "permissions" : {
6307 "check" : [
6308 "admin"
6309 ]
6310 },
6311 "protected" : 1,
6312 "proxyto" : "master",
6313 "returns" : {
6314 "type" : "null"
6315 }
6316 }
6317 },
6318 "leaf" : 0,
6319 "path" : "/config/ldap",
6320 "text" : "ldap"
6321 },
6322 {
6323 "children" : [
6324 {
6325 "info" : {
6326 "DELETE" : {
6327 "allowtoken" : 1,
6328 "description" : "Delete a relay domain",
6329 "method" : "DELETE",
6330 "name" : "delete",
6331 "parameters" : {
6332 "additionalProperties" : 0,
6333 "properties" : {
6334 "domain" : {
6335 "description" : "Domain name.",
6336 "format" : "transport-domain",
6337 "type" : "string",
6338 "typetext" : "<string>"
6339 }
6340 }
6341 },
6342 "permissions" : {
6343 "check" : [
6344 "admin"
6345 ]
6346 },
6347 "protected" : 1,
6348 "proxyto" : "master",
6349 "returns" : {
6350 "type" : "null"
6351 }
6352 },
6353 "GET" : {
6354 "allowtoken" : 1,
6355 "description" : "Read Domain data (comment).",
6356 "method" : "GET",
6357 "name" : "read",
6358 "parameters" : {
6359 "additionalProperties" : 0,
6360 "properties" : {
6361 "domain" : {
6362 "description" : "Domain name.",
6363 "format" : "transport-domain",
6364 "type" : "string",
6365 "typetext" : "<string>"
6366 }
6367 }
6368 },
6369 "permissions" : {
6370 "check" : [
6371 "admin",
6372 "audit"
6373 ]
6374 },
6375 "proxyto" : "master",
6376 "returns" : {
6377 "properties" : {
6378 "comment" : {
6379 "type" : "string"
6380 },
6381 "domain" : {
6382 "type" : "string"
6383 }
6384 },
6385 "type" : "object"
6386 }
6387 },
6388 "PUT" : {
6389 "allowtoken" : 1,
6390 "description" : "Update relay domain data (comment).",
6391 "method" : "PUT",
6392 "name" : "write",
6393 "parameters" : {
6394 "additionalProperties" : 0,
6395 "properties" : {
6396 "comment" : {
6397 "description" : "Comment.",
6398 "type" : "string",
6399 "typetext" : "<string>"
6400 },
6401 "domain" : {
6402 "description" : "Domain name.",
6403 "format" : "transport-domain",
6404 "type" : "string",
6405 "typetext" : "<string>"
6406 }
6407 }
6408 },
6409 "permissions" : {
6410 "check" : [
6411 "admin"
6412 ]
6413 },
6414 "protected" : 1,
6415 "proxyto" : "master",
6416 "returns" : {
6417 "type" : "null"
6418 }
6419 }
6420 },
6421 "leaf" : 1,
6422 "path" : "/config/domains/{domain}",
6423 "text" : "{domain}"
6424 }
6425 ],
6426 "info" : {
6427 "GET" : {
6428 "allowtoken" : 1,
6429 "description" : "List relay domains.",
6430 "method" : "GET",
6431 "name" : "index",
6432 "parameters" : {
6433 "additionalProperties" : 0
6434 },
6435 "permissions" : {
6436 "check" : [
6437 "admin",
6438 "audit"
6439 ]
6440 },
6441 "proxyto" : "master",
6442 "returns" : {
6443 "items" : {
6444 "properties" : {
6445 "comment" : {
6446 "type" : "string"
6447 },
6448 "domain" : {
6449 "type" : "string"
6450 }
6451 },
6452 "type" : "object"
6453 },
6454 "links" : [
6455 {
6456 "href" : "{domain}",
6457 "rel" : "child"
6458 }
6459 ],
6460 "type" : "array"
6461 }
6462 },
6463 "POST" : {
6464 "allowtoken" : 1,
6465 "description" : "Add relay domain.",
6466 "method" : "POST",
6467 "name" : "create",
6468 "parameters" : {
6469 "additionalProperties" : 0,
6470 "properties" : {
6471 "comment" : {
6472 "description" : "Comment.",
6473 "optional" : 1,
6474 "type" : "string",
6475 "typetext" : "<string>"
6476 },
6477 "domain" : {
6478 "description" : "Domain name.",
6479 "format" : "transport-domain",
6480 "type" : "string",
6481 "typetext" : "<string>"
6482 }
6483 }
6484 },
6485 "permissions" : {
6486 "check" : [
6487 "admin"
6488 ]
6489 },
6490 "protected" : 1,
6491 "proxyto" : "master",
6492 "returns" : {
6493 "type" : "null"
6494 }
6495 }
6496 },
6497 "leaf" : 0,
6498 "path" : "/config/domains",
6499 "text" : "domains"
6500 },
6501 {
6502 "children" : [
6503 {
6504 "info" : {
6505 "DELETE" : {
6506 "allowtoken" : 1,
6507 "description" : "Delete a fetchmail configuration entry.",
6508 "method" : "DELETE",
6509 "name" : "delete",
6510 "parameters" : {
6511 "additionalProperties" : 0,
6512 "properties" : {
6513 "id" : {
6514 "description" : "Unique ID",
6515 "maxLength" : 16,
6516 "pattern" : "[A-Za-z0-9]+",
6517 "type" : "string"
6518 }
6519 }
6520 },
6521 "permissions" : {
6522 "check" : [
6523 "admin"
6524 ]
6525 },
6526 "protected" : 1,
6527 "proxyto" : "master",
6528 "returns" : {
6529 "type" : "null"
6530 }
6531 },
6532 "GET" : {
6533 "allowtoken" : 1,
6534 "description" : "Read fetchmail user configuration.",
6535 "method" : "GET",
6536 "name" : "read",
6537 "parameters" : {
6538 "additionalProperties" : 0,
6539 "properties" : {
6540 "id" : {
6541 "description" : "Unique ID",
6542 "maxLength" : 16,
6543 "pattern" : "[A-Za-z0-9]+",
6544 "type" : "string"
6545 }
6546 }
6547 },
6548 "permissions" : {
6549 "check" : [
6550 "admin",
6551 "audit"
6552 ]
6553 },
6554 "protected" : 1,
6555 "proxyto" : "master",
6556 "returns" : {
6557 "properties" : {
6558 "enable" : {
6559 "default" : 0,
6560 "description" : "Flag to enable or disable polling.",
6561 "optional" : 1,
6562 "type" : "boolean"
6563 },
6564 "id" : {
6565 "description" : "Unique ID",
6566 "maxLength" : 16,
6567 "pattern" : "[A-Za-z0-9]+",
6568 "type" : "string"
6569 },
6570 "interval" : {
6571 "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
6572 "maximum" : 2016,
6573 "minimum" : 1,
6574 "optional" : 1,
6575 "type" : "integer"
6576 },
6577 "keep" : {
6578 "default" : 0,
6579 "description" : "Keep retrieved messages on the remote mailserver.",
6580 "optional" : 1,
6581 "type" : "boolean"
6582 },
6583 "pass" : {
6584 "description" : "The password used tfor server login.",
6585 "maxLength" : 64,
6586 "optional" : 1,
6587 "type" : "string"
6588 },
6589 "port" : {
6590 "description" : "Port number.",
6591 "maximum" : 65535,
6592 "minimum" : 1,
6593 "optional" : 1,
6594 "type" : "integer"
6595 },
6596 "protocol" : {
6597 "description" : "Specify the protocol to use when communicating with the remote mailserver",
6598 "enum" : [
6599 "pop3",
6600 "imap"
6601 ],
6602 "optional" : 1,
6603 "type" : "string"
6604 },
6605 "server" : {
6606 "description" : "Server address (IP or DNS name).",
6607 "format" : "address",
6608 "optional" : 1,
6609 "type" : "string"
6610 },
6611 "ssl" : {
6612 "default" : 0,
6613 "description" : "Use SSL.",
6614 "optional" : 1,
6615 "type" : "boolean"
6616 },
6617 "target" : {
6618 "description" : "The target email address (where to deliver fetched mails).",
6619 "maxLength" : 512,
6620 "minLength" : 3,
6621 "optional" : 1,
6622 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
6623 "type" : "string"
6624 },
6625 "user" : {
6626 "description" : "The user identification to be used when logging in to the server",
6627 "maxLength" : 64,
6628 "minLength" : 1,
6629 "optional" : 1,
6630 "type" : "string"
6631 }
6632 },
6633 "type" : "object"
6634 }
6635 },
6636 "PUT" : {
6637 "allowtoken" : 1,
6638 "description" : "Update fetchmail user configuration.",
6639 "method" : "PUT",
6640 "name" : "write",
6641 "parameters" : {
6642 "additionalProperties" : 0,
6643 "properties" : {
6644 "enable" : {
6645 "default" : 0,
6646 "description" : "Flag to enable or disable polling.",
6647 "optional" : 1,
6648 "type" : "boolean",
6649 "typetext" : "<boolean>"
6650 },
6651 "id" : {
6652 "description" : "Unique ID",
6653 "maxLength" : 16,
6654 "pattern" : "[A-Za-z0-9]+",
6655 "type" : "string"
6656 },
6657 "interval" : {
6658 "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
6659 "maximum" : 2016,
6660 "minimum" : 1,
6661 "optional" : 1,
6662 "type" : "integer",
6663 "typetext" : "<integer> (1 - 2016)"
6664 },
6665 "keep" : {
6666 "default" : 0,
6667 "description" : "Keep retrieved messages on the remote mailserver.",
6668 "optional" : 1,
6669 "type" : "boolean",
6670 "typetext" : "<boolean>"
6671 },
6672 "pass" : {
6673 "description" : "The password used tfor server login.",
6674 "maxLength" : 64,
6675 "optional" : 1,
6676 "type" : "string",
6677 "typetext" : "<string>"
6678 },
6679 "port" : {
6680 "description" : "Port number.",
6681 "maximum" : 65535,
6682 "minimum" : 1,
6683 "optional" : 1,
6684 "type" : "integer",
6685 "typetext" : "<integer> (1 - 65535)"
6686 },
6687 "protocol" : {
6688 "description" : "Specify the protocol to use when communicating with the remote mailserver",
6689 "enum" : [
6690 "pop3",
6691 "imap"
6692 ],
6693 "optional" : 1,
6694 "type" : "string"
6695 },
6696 "server" : {
6697 "description" : "Server address (IP or DNS name).",
6698 "format" : "address",
6699 "optional" : 1,
6700 "type" : "string",
6701 "typetext" : "<string>"
6702 },
6703 "ssl" : {
6704 "default" : 0,
6705 "description" : "Use SSL.",
6706 "optional" : 1,
6707 "type" : "boolean",
6708 "typetext" : "<boolean>"
6709 },
6710 "target" : {
6711 "description" : "The target email address (where to deliver fetched mails).",
6712 "maxLength" : 512,
6713 "minLength" : 3,
6714 "optional" : 1,
6715 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
6716 "type" : "string"
6717 },
6718 "user" : {
6719 "description" : "The user identification to be used when logging in to the server",
6720 "maxLength" : 64,
6721 "minLength" : 1,
6722 "optional" : 1,
6723 "type" : "string",
6724 "typetext" : "<string>"
6725 }
6726 }
6727 },
6728 "permissions" : {
6729 "check" : [
6730 "admin"
6731 ]
6732 },
6733 "protected" : 1,
6734 "proxyto" : "master",
6735 "returns" : {
6736 "type" : "null"
6737 }
6738 }
6739 },
6740 "leaf" : 1,
6741 "path" : "/config/fetchmail/{id}",
6742 "text" : "{id}"
6743 }
6744 ],
6745 "info" : {
6746 "GET" : {
6747 "allowtoken" : 1,
6748 "description" : "List fetchmail users.",
6749 "method" : "GET",
6750 "name" : "index",
6751 "parameters" : {
6752 "additionalProperties" : 0
6753 },
6754 "permissions" : {
6755 "check" : [
6756 "admin",
6757 "audit"
6758 ]
6759 },
6760 "protected" : 1,
6761 "proxyto" : "master",
6762 "returns" : {
6763 "items" : {
6764 "properties" : {
6765 "enable" : {
6766 "default" : 0,
6767 "description" : "Flag to enable or disable polling.",
6768 "optional" : 1,
6769 "type" : "boolean"
6770 },
6771 "id" : {
6772 "description" : "Unique ID",
6773 "maxLength" : 16,
6774 "pattern" : "[A-Za-z0-9]+",
6775 "type" : "string"
6776 },
6777 "interval" : {
6778 "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
6779 "maximum" : 2016,
6780 "minimum" : 1,
6781 "optional" : 1,
6782 "type" : "integer"
6783 },
6784 "keep" : {
6785 "default" : 0,
6786 "description" : "Keep retrieved messages on the remote mailserver.",
6787 "optional" : 1,
6788 "type" : "boolean"
6789 },
6790 "pass" : {
6791 "description" : "The password used tfor server login.",
6792 "maxLength" : 64,
6793 "optional" : 1,
6794 "type" : "string"
6795 },
6796 "port" : {
6797 "description" : "Port number.",
6798 "maximum" : 65535,
6799 "minimum" : 1,
6800 "optional" : 1,
6801 "type" : "integer"
6802 },
6803 "protocol" : {
6804 "description" : "Specify the protocol to use when communicating with the remote mailserver",
6805 "enum" : [
6806 "pop3",
6807 "imap"
6808 ],
6809 "optional" : 1,
6810 "type" : "string"
6811 },
6812 "server" : {
6813 "description" : "Server address (IP or DNS name).",
6814 "format" : "address",
6815 "optional" : 1,
6816 "type" : "string"
6817 },
6818 "ssl" : {
6819 "default" : 0,
6820 "description" : "Use SSL.",
6821 "optional" : 1,
6822 "type" : "boolean"
6823 },
6824 "target" : {
6825 "description" : "The target email address (where to deliver fetched mails).",
6826 "maxLength" : 512,
6827 "minLength" : 3,
6828 "optional" : 1,
6829 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
6830 "type" : "string"
6831 },
6832 "user" : {
6833 "description" : "The user identification to be used when logging in to the server",
6834 "maxLength" : 64,
6835 "minLength" : 1,
6836 "optional" : 1,
6837 "type" : "string"
6838 }
6839 },
6840 "type" : "object"
6841 },
6842 "links" : [
6843 {
6844 "href" : "{id}",
6845 "rel" : "child"
6846 }
6847 ],
6848 "type" : "array"
6849 }
6850 },
6851 "POST" : {
6852 "allowtoken" : 1,
6853 "description" : "Create fetchmail user configuration.",
6854 "method" : "POST",
6855 "name" : "create",
6856 "parameters" : {
6857 "additionalProperties" : 0,
6858 "properties" : {
6859 "enable" : {
6860 "default" : 0,
6861 "description" : "Flag to enable or disable polling.",
6862 "optional" : 1,
6863 "type" : "boolean",
6864 "typetext" : "<boolean>"
6865 },
6866 "interval" : {
6867 "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
6868 "maximum" : 2016,
6869 "minimum" : 1,
6870 "optional" : 1,
6871 "type" : "integer",
6872 "typetext" : "<integer> (1 - 2016)"
6873 },
6874 "keep" : {
6875 "default" : 0,
6876 "description" : "Keep retrieved messages on the remote mailserver.",
6877 "optional" : 1,
6878 "type" : "boolean",
6879 "typetext" : "<boolean>"
6880 },
6881 "pass" : {
6882 "description" : "The password used tfor server login.",
6883 "maxLength" : 64,
6884 "type" : "string",
6885 "typetext" : "<string>"
6886 },
6887 "port" : {
6888 "description" : "Port number.",
6889 "maximum" : 65535,
6890 "minimum" : 1,
6891 "optional" : 1,
6892 "type" : "integer",
6893 "typetext" : "<integer> (1 - 65535)"
6894 },
6895 "protocol" : {
6896 "description" : "Specify the protocol to use when communicating with the remote mailserver",
6897 "enum" : [
6898 "pop3",
6899 "imap"
6900 ],
6901 "type" : "string"
6902 },
6903 "server" : {
6904 "description" : "Server address (IP or DNS name).",
6905 "format" : "address",
6906 "type" : "string",
6907 "typetext" : "<string>"
6908 },
6909 "ssl" : {
6910 "default" : 0,
6911 "description" : "Use SSL.",
6912 "optional" : 1,
6913 "type" : "boolean",
6914 "typetext" : "<boolean>"
6915 },
6916 "target" : {
6917 "description" : "The target email address (where to deliver fetched mails).",
6918 "maxLength" : 512,
6919 "minLength" : 3,
6920 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
6921 "type" : "string"
6922 },
6923 "user" : {
6924 "description" : "The user identification to be used when logging in to the server",
6925 "maxLength" : 64,
6926 "minLength" : 1,
6927 "type" : "string",
6928 "typetext" : "<string>"
6929 }
6930 }
6931 },
6932 "permissions" : {
6933 "check" : [
6934 "admin"
6935 ]
6936 },
6937 "protected" : 1,
6938 "proxyto" : "master",
6939 "returns" : {
6940 "description" : "Unique ID",
6941 "maxLength" : 16,
6942 "pattern" : "[A-Za-z0-9]+",
6943 "type" : "string"
6944 }
6945 }
6946 },
6947 "leaf" : 0,
6948 "path" : "/config/fetchmail",
6949 "text" : "fetchmail"
6950 },
6951 {
6952 "children" : [
6953 {
6954 "info" : {
6955 "DELETE" : {
6956 "allowtoken" : 1,
6957 "description" : "Delete a transport map entry",
6958 "method" : "DELETE",
6959 "name" : "delete",
6960 "parameters" : {
6961 "additionalProperties" : 0,
6962 "properties" : {
6963 "domain" : {
6964 "description" : "Domain name.",
6965 "format" : "transport-domain-or-email",
6966 "type" : "string",
6967 "typetext" : "<string>"
6968 }
6969 }
6970 },
6971 "permissions" : {
6972 "check" : [
6973 "admin"
6974 ]
6975 },
6976 "protected" : 1,
6977 "proxyto" : "master",
6978 "returns" : {
6979 "type" : "null"
6980 }
6981 },
6982 "GET" : {
6983 "allowtoken" : 1,
6984 "description" : "Read transport map entry.",
6985 "method" : "GET",
6986 "name" : "read",
6987 "parameters" : {
6988 "additionalProperties" : 0,
6989 "properties" : {
6990 "domain" : {
6991 "description" : "Domain name.",
6992 "format" : "transport-domain-or-email",
6993 "type" : "string",
6994 "typetext" : "<string>"
6995 }
6996 }
6997 },
6998 "permissions" : {
6999 "check" : [
7000 "admin",
7001 "audit"
7002 ]
7003 },
7004 "proxyto" : "master",
7005 "returns" : {
7006 "properties" : {
7007 "comment" : {
7008 "type" : "string"
7009 },
7010 "domain" : {
7011 "type" : "string"
7012 },
7013 "host" : {
7014 "type" : "string"
7015 },
7016 "port" : {
7017 "type" : "integer"
7018 },
7019 "protocol" : {
7020 "type" : "string"
7021 },
7022 "use_mx" : {
7023 "type" : "boolean"
7024 }
7025 },
7026 "type" : "object"
7027 }
7028 },
7029 "PUT" : {
7030 "allowtoken" : 1,
7031 "description" : "Update transport map entry.",
7032 "method" : "PUT",
7033 "name" : "write",
7034 "parameters" : {
7035 "additionalProperties" : 0,
7036 "properties" : {
7037 "comment" : {
7038 "description" : "Comment.",
7039 "optional" : 1,
7040 "type" : "string",
7041 "typetext" : "<string>"
7042 },
7043 "domain" : {
7044 "description" : "Domain name.",
7045 "format" : "transport-domain-or-email",
7046 "type" : "string",
7047 "typetext" : "<string>"
7048 },
7049 "host" : {
7050 "description" : "Target host (name or IP address).",
7051 "format" : "transport-address",
7052 "optional" : 1,
7053 "type" : "string",
7054 "typetext" : "<string>"
7055 },
7056 "port" : {
7057 "description" : "Transport port.",
7058 "maximum" : 65535,
7059 "minimum" : 1,
7060 "optional" : 1,
7061 "type" : "integer",
7062 "typetext" : "<integer> (1 - 65535)"
7063 },
7064 "protocol" : {
7065 "default" : "smtp",
7066 "description" : "Transport protocol.",
7067 "enum" : [
7068 "smtp",
7069 "lmtp"
7070 ],
7071 "optional" : 1,
7072 "type" : "string"
7073 },
7074 "use_mx" : {
7075 "description" : "Enable MX lookups (SMTP).",
7076 "optional" : 1,
7077 "type" : "boolean",
7078 "typetext" : "<boolean>"
7079 }
7080 }
7081 },
7082 "permissions" : {
7083 "check" : [
7084 "admin"
7085 ]
7086 },
7087 "protected" : 1,
7088 "proxyto" : "master",
7089 "returns" : {
7090 "type" : "null"
7091 }
7092 }
7093 },
7094 "leaf" : 1,
7095 "path" : "/config/transport/{domain}",
7096 "text" : "{domain}"
7097 }
7098 ],
7099 "info" : {
7100 "GET" : {
7101 "allowtoken" : 1,
7102 "description" : "List transport map entries.",
7103 "method" : "GET",
7104 "name" : "index",
7105 "parameters" : {
7106 "additionalProperties" : 0
7107 },
7108 "permissions" : {
7109 "check" : [
7110 "admin",
7111 "audit"
7112 ]
7113 },
7114 "proxyto" : "master",
7115 "returns" : {
7116 "items" : {
7117 "properties" : {
7118 "comment" : {
7119 "type" : "string"
7120 },
7121 "domain" : {
7122 "type" : "string"
7123 },
7124 "host" : {
7125 "type" : "string"
7126 },
7127 "port" : {
7128 "type" : "integer"
7129 },
7130 "protocol" : {
7131 "type" : "string"
7132 },
7133 "use_mx" : {
7134 "type" : "boolean"
7135 }
7136 },
7137 "type" : "object"
7138 },
7139 "links" : [
7140 {
7141 "href" : "{domain}",
7142 "rel" : "child"
7143 }
7144 ],
7145 "type" : "array"
7146 }
7147 },
7148 "POST" : {
7149 "allowtoken" : 1,
7150 "description" : "Add transport map entry.",
7151 "method" : "POST",
7152 "name" : "create",
7153 "parameters" : {
7154 "additionalProperties" : 0,
7155 "properties" : {
7156 "comment" : {
7157 "description" : "Comment.",
7158 "optional" : 1,
7159 "type" : "string",
7160 "typetext" : "<string>"
7161 },
7162 "domain" : {
7163 "description" : "Domain name.",
7164 "format" : "transport-domain-or-email",
7165 "type" : "string",
7166 "typetext" : "<string>"
7167 },
7168 "host" : {
7169 "description" : "Target host (name or IP address).",
7170 "format" : "transport-address",
7171 "type" : "string",
7172 "typetext" : "<string>"
7173 },
7174 "port" : {
7175 "default" : 25,
7176 "description" : "Transport port.",
7177 "maximum" : 65535,
7178 "minimum" : 1,
7179 "optional" : 1,
7180 "type" : "integer",
7181 "typetext" : "<integer> (1 - 65535)"
7182 },
7183 "protocol" : {
7184 "default" : "smtp",
7185 "description" : "Transport protocol.",
7186 "enum" : [
7187 "smtp",
7188 "lmtp"
7189 ],
7190 "optional" : 1,
7191 "type" : "string"
7192 },
7193 "use_mx" : {
7194 "default" : 1,
7195 "description" : "Enable MX lookups (SMTP).",
7196 "optional" : 1,
7197 "type" : "boolean",
7198 "typetext" : "<boolean>"
7199 }
7200 }
7201 },
7202 "permissions" : {
7203 "check" : [
7204 "admin"
7205 ]
7206 },
7207 "protected" : 1,
7208 "proxyto" : "master",
7209 "returns" : {
7210 "type" : "null"
7211 }
7212 }
7213 },
7214 "leaf" : 0,
7215 "path" : "/config/transport",
7216 "text" : "transport"
7217 },
7218 {
7219 "children" : [
7220 {
7221 "info" : {
7222 "DELETE" : {
7223 "allowtoken" : 1,
7224 "description" : "Delete a truster network",
7225 "method" : "DELETE",
7226 "name" : "delete",
7227 "parameters" : {
7228 "additionalProperties" : 0,
7229 "properties" : {
7230 "cidr" : {
7231 "description" : "IPv4 or IPv6 network in CIDR notation.",
7232 "format" : "CIDR",
7233 "type" : "string",
7234 "typetext" : "<string>"
7235 }
7236 }
7237 },
7238 "permissions" : {
7239 "check" : [
7240 "admin"
7241 ]
7242 },
7243 "protected" : 1,
7244 "proxyto" : "master",
7245 "returns" : {
7246 "type" : "null"
7247 }
7248 },
7249 "GET" : {
7250 "allowtoken" : 1,
7251 "description" : "Read trusted network data (comment).",
7252 "method" : "GET",
7253 "name" : "read",
7254 "parameters" : {
7255 "additionalProperties" : 0,
7256 "properties" : {
7257 "cidr" : {
7258 "description" : "IPv4 or IPv6 network in CIDR notation.",
7259 "format" : "CIDR",
7260 "type" : "string",
7261 "typetext" : "<string>"
7262 }
7263 }
7264 },
7265 "permissions" : {
7266 "check" : [
7267 "admin",
7268 "audit"
7269 ]
7270 },
7271 "proxyto" : "master",
7272 "returns" : {
7273 "properties" : {
7274 "cidr" : {
7275 "type" : "string"
7276 },
7277 "comment" : {
7278 "type" : "string"
7279 }
7280 },
7281 "type" : "object"
7282 }
7283 },
7284 "PUT" : {
7285 "allowtoken" : 1,
7286 "description" : "Update trusted data (comment).",
7287 "method" : "PUT",
7288 "name" : "write",
7289 "parameters" : {
7290 "additionalProperties" : 0,
7291 "properties" : {
7292 "cidr" : {
7293 "description" : "IPv4 or IPv6 network in CIDR notation.",
7294 "type" : "string",
7295 "typetext" : "<string>"
7296 },
7297 "comment" : {
7298 "description" : "Comment.",
7299 "type" : "string",
7300 "typetext" : "<string>"
7301 }
7302 }
7303 },
7304 "permissions" : {
7305 "check" : [
7306 "admin"
7307 ]
7308 },
7309 "protected" : 1,
7310 "proxyto" : "master",
7311 "returns" : {
7312 "type" : "null"
7313 }
7314 }
7315 },
7316 "leaf" : 1,
7317 "path" : "/config/mynetworks/{cidr}",
7318 "text" : "{cidr}"
7319 }
7320 ],
7321 "info" : {
7322 "GET" : {
7323 "allowtoken" : 1,
7324 "description" : "List of trusted networks from where SMTP clients are allowed to relay mail through Proxmox Mail Gateway.",
7325 "method" : "GET",
7326 "name" : "index",
7327 "parameters" : {
7328 "additionalProperties" : 0
7329 },
7330 "permissions" : {
7331 "check" : [
7332 "admin",
7333 "audit"
7334 ]
7335 },
7336 "proxyto" : "master",
7337 "returns" : {
7338 "items" : {
7339 "properties" : {
7340 "cidr" : {
7341 "type" : "string"
7342 }
7343 },
7344 "type" : "object"
7345 },
7346 "links" : [
7347 {
7348 "href" : "{cidr}",
7349 "rel" : "child"
7350 }
7351 ],
7352 "type" : "array"
7353 }
7354 },
7355 "POST" : {
7356 "allowtoken" : 1,
7357 "description" : "Add a trusted network.",
7358 "method" : "POST",
7359 "name" : "create",
7360 "parameters" : {
7361 "additionalProperties" : 0,
7362 "properties" : {
7363 "cidr" : {
7364 "description" : "IPv4 or IPv6 network in CIDR notation.",
7365 "format" : "CIDR",
7366 "type" : "string",
7367 "typetext" : "<string>"
7368 },
7369 "comment" : {
7370 "description" : "Comment.",
7371 "optional" : 1,
7372 "type" : "string",
7373 "typetext" : "<string>"
7374 }
7375 }
7376 },
7377 "permissions" : {
7378 "check" : [
7379 "admin"
7380 ]
7381 },
7382 "protected" : 1,
7383 "proxyto" : "master",
7384 "returns" : {
7385 "type" : "null"
7386 }
7387 }
7388 },
7389 "leaf" : 0,
7390 "path" : "/config/mynetworks",
7391 "text" : "mynetworks"
7392 },
7393 {
7394 "children" : [
7395 {
7396 "info" : {
7397 "GET" : {
7398 "allowtoken" : 1,
7399 "description" : "Cluster node index.",
7400 "method" : "GET",
7401 "name" : "nodes",
7402 "parameters" : {
7403 "additionalProperties" : 0
7404 },
7405 "permissions" : {
7406 "check" : [
7407 "admin",
7408 "qmanager",
7409 "audit"
7410 ]
7411 },
7412 "returns" : {
7413 "items" : {
7414 "properties" : {
7415 "cid" : {
7416 "type" : "integer"
7417 },
7418 "fingerprint" : {
7419 "type" : "string"
7420 },
7421 "hostrsapubkey" : {
7422 "type" : "string"
7423 },
7424 "ip" : {
7425 "type" : "string"
7426 },
7427 "name" : {
7428 "type" : "string"
7429 },
7430 "rootrsapubkey" : {
7431 "type" : "string"
7432 },
7433 "type" : {
7434 "type" : "string"
7435 }
7436 },
7437 "type" : "object"
7438 },
7439 "type" : "array"
7440 }
7441 },
7442 "POST" : {
7443 "allowtoken" : 1,
7444 "description" : "Add an node to the cluster config.",
7445 "method" : "POST",
7446 "name" : "add_node",
7447 "parameters" : {
7448 "additionalProperties" : 0,
7449 "properties" : {
7450 "fingerprint" : {
7451 "description" : "SSL certificate fingerprint.",
7452 "optional" : 0,
7453 "pattern" : "^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$",
7454 "type" : "string"
7455 },
7456 "hostrsapubkey" : {
7457 "description" : "Public SSH RSA key for the host.",
7458 "optional" : 0,
7459 "pattern" : "^[A-Za-z0-9\\.\\/\\+]{200,}$",
7460 "type" : "string"
7461 },
7462 "ip" : {
7463 "description" : "IP address.",
7464 "format" : "ip",
7465 "optional" : 0,
7466 "type" : "string",
7467 "typetext" : "<string>"
7468 },
7469 "maxcid" : {
7470 "description" : "Maximum used cluster node ID (used internally, do not modify).",
7471 "minimum" : 1,
7472 "optional" : 1,
7473 "type" : "integer",
7474 "typetext" : "<integer> (1 - N)"
7475 },
7476 "name" : {
7477 "description" : "Node name.",
7478 "format" : "pve-node",
7479 "optional" : 0,
7480 "type" : "string",
7481 "typetext" : "<string>"
7482 },
7483 "rootrsapubkey" : {
7484 "description" : "Public SSH RSA key for the root user.",
7485 "optional" : 0,
7486 "pattern" : "^[A-Za-z0-9\\.\\/\\+]{200,}$",
7487 "type" : "string"
7488 }
7489 },
7490 "type" : "object"
7491 },
7492 "protected" : 1,
7493 "proxyto" : "master",
7494 "returns" : {
7495 "description" : "Returns the resulting node list.",
7496 "items" : {
7497 "properties" : {
7498 "cid" : {
7499 "type" : "integer"
7500 }
7501 },
7502 "type" : "object"
7503 },
7504 "type" : "array"
7505 }
7506 }
7507 },
7508 "leaf" : 1,
7509 "path" : "/config/cluster/nodes",
7510 "text" : "nodes"
7511 },
7512 {
7513 "info" : {
7514 "GET" : {
7515 "allowtoken" : 1,
7516 "description" : "Cluster node status.",
7517 "method" : "GET",
7518 "name" : "status",
7519 "parameters" : {
7520 "additionalProperties" : 0,
7521 "properties" : {
7522 "list_single_node" : {
7523 "default" : 0,
7524 "description" : "List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case.",
7525 "optional" : 1,
7526 "type" : "boolean",
7527 "typetext" : "<boolean>"
7528 }
7529 }
7530 },
7531 "permissions" : {
7532 "check" : [
7533 "admin",
7534 "qmanager",
7535 "audit"
7536 ]
7537 },
7538 "returns" : {
7539 "items" : {
7540 "properties" : {
7541 "cid" : {
7542 "type" : "integer"
7543 },
7544 "fingerprint" : {
7545 "type" : "string"
7546 },
7547 "hostrsapubkey" : {
7548 "type" : "string"
7549 },
7550 "ip" : {
7551 "type" : "string"
7552 },
7553 "name" : {
7554 "type" : "string"
7555 },
7556 "rootrsapubkey" : {
7557 "type" : "string"
7558 },
7559 "type" : {
7560 "type" : "string"
7561 }
7562 },
7563 "type" : "object"
7564 },
7565 "links" : [
7566 {
7567 "href" : "{cid}",
7568 "rel" : "child"
7569 }
7570 ],
7571 "type" : "array"
7572 }
7573 }
7574 },
7575 "leaf" : 1,
7576 "path" : "/config/cluster/status",
7577 "text" : "status"
7578 },
7579 {
7580 "info" : {
7581 "POST" : {
7582 "allowtoken" : 1,
7583 "description" : "Create initial cluster config with current node as master.",
7584 "method" : "POST",
7585 "name" : "create",
7586 "parameters" : {
7587 "additionalProperties" : 0
7588 },
7589 "protected" : 1,
7590 "returns" : {
7591 "type" : "string"
7592 }
7593 }
7594 },
7595 "leaf" : 1,
7596 "path" : "/config/cluster/create",
7597 "text" : "create"
7598 },
7599 {
7600 "info" : {
7601 "POST" : {
7602 "allowtoken" : 1,
7603 "description" : "Join local node to an existing cluster.",
7604 "method" : "POST",
7605 "name" : "join",
7606 "parameters" : {
7607 "additionalProperties" : 0,
7608 "properties" : {
7609 "fingerprint" : {
7610 "description" : "SSL certificate fingerprint.",
7611 "pattern" : "^(:?[A-Z0-9][A-Z0-9]:){31}[A-Z0-9][A-Z0-9]$",
7612 "type" : "string"
7613 },
7614 "master_ip" : {
7615 "description" : "IP address.",
7616 "format" : "ip",
7617 "type" : "string",
7618 "typetext" : "<string>"
7619 },
7620 "password" : {
7621 "description" : "Superuser password.",
7622 "maxLength" : 128,
7623 "type" : "string",
7624 "typetext" : "<string>"
7625 }
7626 }
7627 },
7628 "protected" : 1,
7629 "returns" : {
7630 "type" : "string"
7631 }
7632 }
7633 },
7634 "leaf" : 1,
7635 "path" : "/config/cluster/join",
7636 "text" : "join"
7637 },
7638 {
7639 "info" : {
7640 "POST" : {
7641 "allowtoken" : 1,
7642 "description" : "Update API certificate fingerprints (by fetching it via ssh).",
7643 "method" : "POST",
7644 "name" : "update_fingerprints",
7645 "parameters" : {
7646 "additionalProperties" : 0
7647 },
7648 "protected" : 1,
7649 "proxyto" : "master",
7650 "returns" : {
7651 "type" : "null"
7652 }
7653 }
7654 },
7655 "leaf" : 1,
7656 "path" : "/config/cluster/update-fingerprints",
7657 "text" : "update-fingerprints"
7658 }
7659 ],
7660 "info" : {
7661 "GET" : {
7662 "allowtoken" : 1,
7663 "description" : "Directory index.",
7664 "method" : "GET",
7665 "name" : "index",
7666 "parameters" : {
7667 "additionalProperties" : 0
7668 },
7669 "permissions" : {
7670 "user" : "all"
7671 },
7672 "returns" : {
7673 "items" : {
7674 "properties" : {},
7675 "type" : "object"
7676 },
7677 "links" : [
7678 {
7679 "href" : "{name}",
7680 "rel" : "child"
7681 }
7682 ],
7683 "type" : "array"
7684 }
7685 }
7686 },
7687 "leaf" : 0,
7688 "path" : "/config/cluster",
7689 "text" : "cluster"
7690 },
7691 {
7692 "info" : {
7693 "GET" : {
7694 "allowtoken" : 1,
7695 "description" : "Get Mime Types List",
7696 "method" : "GET",
7697 "name" : "index",
7698 "parameters" : {
7699 "additionalProperties" : 0
7700 },
7701 "returns" : {
7702 "items" : {
7703 "properties" : {
7704 "mimetype" : {
7705 "type" : "string"
7706 },
7707 "text" : {
7708 "type" : "string"
7709 }
7710 },
7711 "type" : "object"
7712 },
7713 "type" : "array"
7714 }
7715 }
7716 },
7717 "leaf" : 1,
7718 "path" : "/config/mimetypes",
7719 "text" : "mimetypes"
7720 },
7721 {
7722 "children" : [
7723 {
7724 "info" : {
7725 "DELETE" : {
7726 "allowtoken" : 1,
7727 "description" : "Delete a tls_policy entry",
7728 "method" : "DELETE",
7729 "name" : "delete",
7730 "parameters" : {
7731 "additionalProperties" : 0,
7732 "properties" : {
7733 "destination" : {
7734 "description" : "Destination (Domain or next-hop).",
7735 "format" : "transport-domain-or-nexthop",
7736 "type" : "string",
7737 "typetext" : "<string>"
7738 }
7739 }
7740 },
7741 "permissions" : {
7742 "check" : [
7743 "admin"
7744 ]
7745 },
7746 "protected" : 1,
7747 "proxyto" : "master",
7748 "returns" : {
7749 "type" : "null"
7750 }
7751 },
7752 "GET" : {
7753 "allowtoken" : 1,
7754 "description" : "Read tls_policy entry.",
7755 "method" : "GET",
7756 "name" : "read",
7757 "parameters" : {
7758 "additionalProperties" : 0,
7759 "properties" : {
7760 "destination" : {
7761 "description" : "Destination (Domain or next-hop).",
7762 "format" : "transport-domain-or-nexthop",
7763 "type" : "string",
7764 "typetext" : "<string>"
7765 }
7766 }
7767 },
7768 "permissions" : {
7769 "check" : [
7770 "admin",
7771 "audit"
7772 ]
7773 },
7774 "proxyto" : "master",
7775 "returns" : {
7776 "properties" : {
7777 "destination" : {
7778 "format" : "transport-domain-or-nexthop",
7779 "type" : "string"
7780 },
7781 "policy" : {
7782 "format" : "tls-policy",
7783 "type" : "string"
7784 }
7785 },
7786 "type" : "object"
7787 }
7788 },
7789 "PUT" : {
7790 "allowtoken" : 1,
7791 "description" : "Update tls_policy entry.",
7792 "method" : "PUT",
7793 "name" : "write",
7794 "parameters" : {
7795 "additionalProperties" : 0,
7796 "properties" : {
7797 "destination" : {
7798 "description" : "Destination (Domain or next-hop).",
7799 "format" : "transport-domain-or-nexthop",
7800 "type" : "string",
7801 "typetext" : "<string>"
7802 },
7803 "policy" : {
7804 "description" : "TLS policy",
7805 "format" : "tls-policy-strict",
7806 "type" : "string",
7807 "typetext" : "<string>"
7808 }
7809 }
7810 },
7811 "permissions" : {
7812 "check" : [
7813 "admin"
7814 ]
7815 },
7816 "protected" : 1,
7817 "proxyto" : "master",
7818 "returns" : {
7819 "type" : "null"
7820 }
7821 }
7822 },
7823 "leaf" : 1,
7824 "path" : "/config/tlspolicy/{destination}",
7825 "text" : "{destination}"
7826 }
7827 ],
7828 "info" : {
7829 "GET" : {
7830 "allowtoken" : 1,
7831 "description" : "List tls_policy entries.",
7832 "method" : "GET",
7833 "name" : "index",
7834 "parameters" : {
7835 "additionalProperties" : 0
7836 },
7837 "permissions" : {
7838 "check" : [
7839 "admin",
7840 "audit"
7841 ]
7842 },
7843 "proxyto" : "master",
7844 "returns" : {
7845 "items" : {
7846 "properties" : {
7847 "destination" : {
7848 "format" : "transport-domain-or-nexthop",
7849 "type" : "string"
7850 },
7851 "policy" : {
7852 "format" : "tls-policy",
7853 "type" : "string"
7854 }
7855 },
7856 "type" : "object"
7857 },
7858 "links" : [
7859 {
7860 "href" : "{destination}",
7861 "rel" : "child"
7862 }
7863 ],
7864 "type" : "array"
7865 }
7866 },
7867 "POST" : {
7868 "allowtoken" : 1,
7869 "description" : "Add tls_policy entry.",
7870 "method" : "POST",
7871 "name" : "create",
7872 "parameters" : {
7873 "additionalProperties" : 0,
7874 "properties" : {
7875 "destination" : {
7876 "description" : "Destination (Domain or next-hop).",
7877 "format" : "transport-domain-or-nexthop",
7878 "type" : "string",
7879 "typetext" : "<string>"
7880 },
7881 "policy" : {
7882 "description" : "TLS policy",
7883 "format" : "tls-policy-strict",
7884 "type" : "string",
7885 "typetext" : "<string>"
7886 }
7887 }
7888 },
7889 "permissions" : {
7890 "check" : [
7891 "admin"
7892 ]
7893 },
7894 "protected" : 1,
7895 "proxyto" : "master",
7896 "returns" : {
7897 "type" : "null"
7898 }
7899 }
7900 },
7901 "leaf" : 0,
7902 "path" : "/config/tlspolicy",
7903 "text" : "tlspolicy"
7904 },
7905 {
7906 "children" : [
7907 {
7908 "children" : [
7909 {
7910 "info" : {
7911 "DELETE" : {
7912 "allowtoken" : 1,
7913 "description" : "Delete a DKIM-sign domain",
7914 "method" : "DELETE",
7915 "name" : "delete",
7916 "parameters" : {
7917 "additionalProperties" : 0,
7918 "properties" : {
7919 "domain" : {
7920 "description" : "Domain name.",
7921 "format" : "transport-domain",
7922 "type" : "string",
7923 "typetext" : "<string>"
7924 }
7925 }
7926 },
7927 "permissions" : {
7928 "check" : [
7929 "admin"
7930 ]
7931 },
7932 "protected" : 1,
7933 "proxyto" : "master",
7934 "returns" : {
7935 "type" : "null"
7936 }
7937 },
7938 "GET" : {
7939 "allowtoken" : 1,
7940 "description" : "Read Domain data (comment).",
7941 "method" : "GET",
7942 "name" : "read",
7943 "parameters" : {
7944 "additionalProperties" : 0,
7945 "properties" : {
7946 "domain" : {
7947 "description" : "Domain name.",
7948 "format" : "transport-domain",
7949 "type" : "string",
7950 "typetext" : "<string>"
7951 }
7952 }
7953 },
7954 "permissions" : {
7955 "check" : [
7956 "admin",
7957 "audit"
7958 ]
7959 },
7960 "proxyto" : "master",
7961 "returns" : {
7962 "properties" : {
7963 "comment" : {
7964 "type" : "string"
7965 },
7966 "domain" : {
7967 "type" : "string"
7968 }
7969 },
7970 "type" : "object"
7971 }
7972 },
7973 "PUT" : {
7974 "allowtoken" : 1,
7975 "description" : "Update DKIM-sign domain data (comment).",
7976 "method" : "PUT",
7977 "name" : "write",
7978 "parameters" : {
7979 "additionalProperties" : 0,
7980 "properties" : {
7981 "comment" : {
7982 "description" : "Comment.",
7983 "type" : "string",
7984 "typetext" : "<string>"
7985 },
7986 "domain" : {
7987 "description" : "Domain name.",
7988 "format" : "transport-domain",
7989 "type" : "string",
7990 "typetext" : "<string>"
7991 }
7992 }
7993 },
7994 "permissions" : {
7995 "check" : [
7996 "admin"
7997 ]
7998 },
7999 "protected" : 1,
8000 "proxyto" : "master",
8001 "returns" : {
8002 "type" : "null"
8003 }
8004 }
8005 },
8006 "leaf" : 1,
8007 "path" : "/config/dkim/domains/{domain}",
8008 "text" : "{domain}"
8009 }
8010 ],
8011 "info" : {
8012 "GET" : {
8013 "allowtoken" : 1,
8014 "description" : "List DKIM-sign domains.",
8015 "method" : "GET",
8016 "name" : "index",
8017 "parameters" : {
8018 "additionalProperties" : 0
8019 },
8020 "permissions" : {
8021 "check" : [
8022 "admin",
8023 "audit"
8024 ]
8025 },
8026 "proxyto" : "master",
8027 "returns" : {
8028 "items" : {
8029 "properties" : {
8030 "comment" : {
8031 "type" : "string"
8032 },
8033 "domain" : {
8034 "type" : "string"
8035 }
8036 },
8037 "type" : "object"
8038 },
8039 "links" : [
8040 {
8041 "href" : "{domain}",
8042 "rel" : "child"
8043 }
8044 ],
8045 "type" : "array"
8046 }
8047 },
8048 "POST" : {
8049 "allowtoken" : 1,
8050 "description" : "Add DKIM-sign domain.",
8051 "method" : "POST",
8052 "name" : "create",
8053 "parameters" : {
8054 "additionalProperties" : 0,
8055 "properties" : {
8056 "comment" : {
8057 "description" : "Comment.",
8058 "optional" : 1,
8059 "type" : "string",
8060 "typetext" : "<string>"
8061 },
8062 "domain" : {
8063 "description" : "Domain name.",
8064 "format" : "transport-domain",
8065 "type" : "string",
8066 "typetext" : "<string>"
8067 }
8068 }
8069 },
8070 "permissions" : {
8071 "check" : [
8072 "admin"
8073 ]
8074 },
8075 "protected" : 1,
8076 "proxyto" : "master",
8077 "returns" : {
8078 "type" : "null"
8079 }
8080 }
8081 },
8082 "leaf" : 0,
8083 "path" : "/config/dkim/domains",
8084 "text" : "domains"
8085 },
8086 {
8087 "info" : {
8088 "GET" : {
8089 "allowtoken" : 1,
8090 "description" : "Get the public key for the configured selector, prepared as DKIM TXT record",
8091 "method" : "GET",
8092 "name" : "get_selector_info",
8093 "parameters" : {
8094 "additionalProperties" : 0
8095 },
8096 "permissions" : {
8097 "check" : [
8098 "admin"
8099 ]
8100 },
8101 "protected" : 1,
8102 "proxyto" : "master",
8103 "returns" : {
8104 "properties" : {
8105 "keysize" : {
8106 "minimum" : 1024,
8107 "optional" : 1,
8108 "type" : "integer"
8109 },
8110 "record" : {
8111 "format" : "pmg-dkim-record",
8112 "optional" : 1,
8113 "type" : "string"
8114 },
8115 "selector" : {
8116 "format" : "dns-name",
8117 "optional" : 1,
8118 "type" : "string"
8119 }
8120 },
8121 "type" : "object"
8122 }
8123 },
8124 "POST" : {
8125 "allowtoken" : 1,
8126 "description" : "Generate a new private key for selector. All future mail will be signed with the new key!",
8127 "method" : "POST",
8128 "name" : "set_selector",
8129 "parameters" : {
8130 "additionalProperties" : 0,
8131 "properties" : {
8132 "force" : {
8133 "description" : "Overwrite existing key",
8134 "optional" : 1,
8135 "type" : "boolean",
8136 "typetext" : "<boolean>"
8137 },
8138 "keysize" : {
8139 "description" : "Number of bits for the RSA-Key",
8140 "minimum" : 1024,
8141 "type" : "integer",
8142 "typetext" : "<integer> (1024 - N)"
8143 },
8144 "selector" : {
8145 "description" : "DKIM Selector",
8146 "format" : "dns-name",
8147 "type" : "string",
8148 "typetext" : "<string>"
8149 }
8150 }
8151 },
8152 "permissions" : {
8153 "check" : [
8154 "admin"
8155 ]
8156 },
8157 "protected" : 1,
8158 "proxyto" : "master",
8159 "returns" : {
8160 "type" : "null"
8161 }
8162 }
8163 },
8164 "leaf" : 1,
8165 "path" : "/config/dkim/selector",
8166 "text" : "selector"
8167 },
8168 {
8169 "info" : {
8170 "GET" : {
8171 "allowtoken" : 1,
8172 "description" : "Get a list of all existing selectors",
8173 "method" : "GET",
8174 "name" : "get_selector_list",
8175 "parameters" : {
8176 "additionalProperties" : 0
8177 },
8178 "permissions" : {
8179 "check" : [
8180 "admin"
8181 ]
8182 },
8183 "protected" : 1,
8184 "proxyto" : "master",
8185 "returns" : {
8186 "items" : {
8187 "properties" : {
8188 "selector" : {
8189 "format" : "dns-name",
8190 "type" : "string"
8191 }
8192 },
8193 "type" : "object"
8194 },
8195 "links" : [
8196 {
8197 "href" : "{selector}",
8198 "rel" : "child"
8199 }
8200 ],
8201 "type" : "array"
8202 }
8203 }
8204 },
8205 "leaf" : 1,
8206 "path" : "/config/dkim/selectors",
8207 "text" : "selectors"
8208 }
8209 ],
8210 "info" : {
8211 "GET" : {
8212 "allowtoken" : 1,
8213 "description" : "Directory index.",
8214 "method" : "GET",
8215 "name" : "index",
8216 "parameters" : {
8217 "additionalProperties" : 0
8218 },
8219 "returns" : {
8220 "items" : {
8221 "properties" : {
8222 "section" : {
8223 "type" : "string"
8224 }
8225 },
8226 "type" : "object"
8227 },
8228 "links" : [
8229 {
8230 "href" : "{section}",
8231 "rel" : "child"
8232 }
8233 ],
8234 "type" : "array"
8235 }
8236 }
8237 },
8238 "leaf" : 0,
8239 "path" : "/config/dkim",
8240 "text" : "dkim"
8241 },
8242 {
8243 "children" : [
8244 {
8245 "info" : {
8246 "DELETE" : {
8247 "allowtoken" : 1,
8248 "description" : "Edit custom SpamAssassin score",
8249 "method" : "DELETE",
8250 "name" : "delete_score",
8251 "parameters" : {
8252 "additionalProperties" : 0,
8253 "properties" : {
8254 "digest" : {
8255 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
8256 "maxLength" : 40,
8257 "optional" : 1,
8258 "type" : "string",
8259 "typetext" : "<string>"
8260 },
8261 "name" : {
8262 "description" : "The name of the rule.",
8263 "pattern" : "[a-zA-Z\\_\\-\\.0-9]+",
8264 "type" : "string"
8265 }
8266 }
8267 },
8268 "protected" : 1,
8269 "proxyto" : "master",
8270 "returns" : {
8271 "type" : "null"
8272 }
8273 },
8274 "GET" : {
8275 "allowtoken" : 1,
8276 "description" : "Get custom SpamAssassin score",
8277 "method" : "GET",
8278 "name" : "get_score",
8279 "parameters" : {
8280 "additionalProperties" : 0,
8281 "properties" : {
8282 "name" : {
8283 "description" : "The name of the rule.",
8284 "pattern" : "[a-zA-Z\\_\\-\\.0-9]+",
8285 "type" : "string"
8286 }
8287 }
8288 },
8289 "protected" : 1,
8290 "proxyto" : "master",
8291 "returns" : {
8292 "properties" : {
8293 "comment" : {
8294 "description" : "The Comment.",
8295 "optional" : 1,
8296 "type" : "string"
8297 },
8298 "name" : {
8299 "description" : "The name of the rule.",
8300 "pattern" : "[a-zA-Z\\_\\-\\.0-9]+",
8301 "type" : "string"
8302 },
8303 "score" : {
8304 "description" : "The score the rule should be valued at.",
8305 "type" : "number"
8306 }
8307 },
8308 "type" : "object"
8309 }
8310 },
8311 "PUT" : {
8312 "allowtoken" : 1,
8313 "description" : "Edit custom SpamAssassin score",
8314 "method" : "PUT",
8315 "name" : "edit_score",
8316 "parameters" : {
8317 "additionalProperties" : 0,
8318 "properties" : {
8319 "comment" : {
8320 "description" : "The Comment.",
8321 "optional" : 1,
8322 "type" : "string",
8323 "typetext" : "<string>"
8324 },
8325 "digest" : {
8326 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
8327 "maxLength" : 40,
8328 "optional" : 1,
8329 "type" : "string",
8330 "typetext" : "<string>"
8331 },
8332 "name" : {
8333 "description" : "The name of the rule.",
8334 "pattern" : "[a-zA-Z\\_\\-\\.0-9]+",
8335 "type" : "string"
8336 },
8337 "score" : {
8338 "description" : "The score the rule should be valued at.",
8339 "type" : "number",
8340 "typetext" : "<number>"
8341 }
8342 }
8343 },
8344 "protected" : 1,
8345 "proxyto" : "master",
8346 "returns" : {
8347 "type" : "null"
8348 }
8349 }
8350 },
8351 "leaf" : 1,
8352 "path" : "/config/customscores/{name}",
8353 "text" : "{name}"
8354 }
8355 ],
8356 "info" : {
8357 "DELETE" : {
8358 "allowtoken" : 1,
8359 "description" : "Revert custom score changes.",
8360 "method" : "DELETE",
8361 "name" : "revert_score_changes",
8362 "parameters" : {
8363 "additionalProperties" : 0
8364 },
8365 "permissions" : {
8366 "check" : [
8367 "admin"
8368 ]
8369 },
8370 "protected" : 1,
8371 "proxyto" : "master",
8372 "returns" : {
8373 "type" : "null"
8374 }
8375 },
8376 "GET" : {
8377 "allowtoken" : 1,
8378 "description" : "List custom scores.",
8379 "method" : "GET",
8380 "name" : "list_scores",
8381 "parameters" : {
8382 "additionalProperties" : 0
8383 },
8384 "permissions" : {
8385 "check" : [
8386 "admin",
8387 "audit"
8388 ]
8389 },
8390 "proxyto" : "master",
8391 "returns" : {
8392 "items" : {
8393 "properties" : {
8394 "comment" : {
8395 "description" : "The Comment.",
8396 "optional" : 1,
8397 "type" : "string"
8398 },
8399 "digest" : {
8400 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
8401 "maxLength" : 40,
8402 "optional" : 1,
8403 "type" : "string"
8404 },
8405 "name" : {
8406 "description" : "The name of the rule.",
8407 "optional" : 1,
8408 "pattern" : "[a-zA-Z\\_\\-\\.0-9]+",
8409 "type" : "string"
8410 },
8411 "score" : {
8412 "description" : "The score the rule should be valued at.",
8413 "optional" : 1,
8414 "type" : "number"
8415 }
8416 },
8417 "type" : "object"
8418 },
8419 "links" : [
8420 {
8421 "href" : "{name}",
8422 "rel" : "child"
8423 }
8424 ],
8425 "type" : "array"
8426 }
8427 },
8428 "POST" : {
8429 "allowtoken" : 1,
8430 "description" : "Create custom SpamAssassin score",
8431 "method" : "POST",
8432 "name" : "create_score",
8433 "parameters" : {
8434 "additionalProperties" : 0,
8435 "properties" : {
8436 "comment" : {
8437 "description" : "The Comment.",
8438 "optional" : 1,
8439 "type" : "string",
8440 "typetext" : "<string>"
8441 },
8442 "digest" : {
8443 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
8444 "maxLength" : 40,
8445 "optional" : 1,
8446 "type" : "string",
8447 "typetext" : "<string>"
8448 },
8449 "name" : {
8450 "description" : "The name of the rule.",
8451 "pattern" : "[a-zA-Z\\_\\-\\.0-9]+",
8452 "type" : "string"
8453 },
8454 "score" : {
8455 "description" : "The score the rule should be valued at.",
8456 "type" : "number",
8457 "typetext" : "<number>"
8458 }
8459 }
8460 },
8461 "protected" : 1,
8462 "proxyto" : "master",
8463 "returns" : {
8464 "type" : "null"
8465 }
8466 },
8467 "PUT" : {
8468 "allowtoken" : 1,
8469 "description" : "Apply custom score changes.",
8470 "method" : "PUT",
8471 "name" : "apply_score_changes",
8472 "parameters" : {
8473 "additionalProperties" : 0,
8474 "properties" : {
8475 "digest" : {
8476 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
8477 "maxLength" : 40,
8478 "optional" : 1,
8479 "type" : "string",
8480 "typetext" : "<string>"
8481 },
8482 "restart-daemon" : {
8483 "default" : 0,
8484 "description" : "If set, also restarts pmg-smtp-filter. This is necessary for the changes to work.",
8485 "optional" : 1,
8486 "type" : "boolean",
8487 "typetext" : "<boolean>"
8488 }
8489 }
8490 },
8491 "permissions" : {
8492 "check" : [
8493 "admin"
8494 ]
8495 },
8496 "protected" : 1,
8497 "proxyto" : "master",
8498 "returns" : {
8499 "type" : "string"
8500 }
8501 }
8502 },
8503 "leaf" : 0,
8504 "path" : "/config/customscores",
8505 "text" : "customscores"
8506 },
8507 {
8508 "children" : [
8509 {
8510 "info" : {
8511 "DELETE" : {
8512 "allowtoken" : 1,
8513 "description" : "Delete an PBS remote",
8514 "method" : "DELETE",
8515 "name" : "delete",
8516 "parameters" : {
8517 "additionalProperties" : 0,
8518 "properties" : {
8519 "remote" : {
8520 "description" : "Profile ID.",
8521 "format" : "pve-configid",
8522 "type" : "string",
8523 "typetext" : "<string>"
8524 }
8525 }
8526 },
8527 "permissions" : {
8528 "check" : [
8529 "admin"
8530 ]
8531 },
8532 "protected" : 1,
8533 "proxyto" : "master",
8534 "returns" : {
8535 "type" : "null"
8536 }
8537 },
8538 "GET" : {
8539 "allowtoken" : 1,
8540 "description" : "Get Proxmox Backup Server remote configuration.",
8541 "method" : "GET",
8542 "name" : "read_config",
8543 "parameters" : {
8544 "additionalProperties" : 1,
8545 "properties" : {
8546 "remote" : {
8547 "description" : "Proxmox Backup Server ID.",
8548 "format" : "pve-configid",
8549 "type" : "string",
8550 "typetext" : "<string>"
8551 }
8552 }
8553 },
8554 "permissions" : {
8555 "check" : [
8556 "admin",
8557 "audit"
8558 ]
8559 },
8560 "proxyto" : "master",
8561 "returns" : {}
8562 },
8563 "PUT" : {
8564 "allowtoken" : 1,
8565 "description" : "Update PBS remote settings.",
8566 "method" : "PUT",
8567 "name" : "update_config",
8568 "parameters" : {
8569 "additionalProperties" : 0,
8570 "properties" : {
8571 "datastore" : {
8572 "description" : "Proxmox Backup Server datastore name.",
8573 "optional" : 1,
8574 "type" : "string",
8575 "typetext" : "<string>"
8576 },
8577 "delete" : {
8578 "description" : "A list of settings you want to delete.",
8579 "format" : "pve-configid-list",
8580 "maxLength" : 4096,
8581 "optional" : 1,
8582 "type" : "string",
8583 "typetext" : "<string>"
8584 },
8585 "digest" : {
8586 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
8587 "maxLength" : 40,
8588 "optional" : 1,
8589 "type" : "string",
8590 "typetext" : "<string>"
8591 },
8592 "disable" : {
8593 "description" : "Flag to disable (deactivate) the entry.",
8594 "optional" : 1,
8595 "type" : "boolean",
8596 "typetext" : "<boolean>"
8597 },
8598 "fingerprint" : {
8599 "description" : "Certificate SHA 256 fingerprint.",
8600 "optional" : 1,
8601 "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}",
8602 "type" : "string"
8603 },
8604 "include-statistics" : {
8605 "description" : "Include statistics in scheduled backups",
8606 "optional" : 1,
8607 "type" : "boolean",
8608 "typetext" : "<boolean>"
8609 },
8610 "keep-daily" : {
8611 "description" : "Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.",
8612 "format_description" : "N",
8613 "minimum" : "0",
8614 "optional" : 1,
8615 "type" : "integer",
8616 "typetext" : "<N>"
8617 },
8618 "keep-hourly" : {
8619 "description" : "Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.",
8620 "format_description" : "N",
8621 "minimum" : "0",
8622 "optional" : 1,
8623 "type" : "integer",
8624 "typetext" : "<N>"
8625 },
8626 "keep-last" : {
8627 "description" : "Keep the last <N> backups.",
8628 "format_description" : "N",
8629 "minimum" : "0",
8630 "optional" : 1,
8631 "type" : "integer",
8632 "typetext" : "<N>"
8633 },
8634 "keep-monthly" : {
8635 "description" : "Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.",
8636 "format_description" : "N",
8637 "minimum" : "0",
8638 "optional" : 1,
8639 "type" : "integer",
8640 "typetext" : "<N>"
8641 },
8642 "keep-weekly" : {
8643 "description" : "Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.",
8644 "format_description" : "N",
8645 "minimum" : "0",
8646 "optional" : 1,
8647 "type" : "integer",
8648 "typetext" : "<N>"
8649 },
8650 "keep-yearly" : {
8651 "description" : "Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.",
8652 "format_description" : "N",
8653 "minimum" : "0",
8654 "optional" : 1,
8655 "type" : "integer",
8656 "typetext" : "<N>"
8657 },
8658 "notify" : {
8659 "description" : "Specify when to notify via e-mail",
8660 "enum" : [
8661 "always",
8662 "error",
8663 "never"
8664 ],
8665 "optional" : 1,
8666 "type" : "string"
8667 },
8668 "password" : {
8669 "description" : "Password or API token secret for the user on the Proxmox Backup Server.",
8670 "optional" : 1,
8671 "type" : "string",
8672 "typetext" : "<string>"
8673 },
8674 "remote" : {
8675 "description" : "Proxmox Backup Server ID.",
8676 "format" : "pve-configid",
8677 "type" : "string",
8678 "typetext" : "<string>"
8679 },
8680 "server" : {
8681 "description" : "Proxmox Backup Server address.",
8682 "format" : "address",
8683 "maxLength" : 256,
8684 "optional" : 1,
8685 "type" : "string",
8686 "typetext" : "<string>"
8687 },
8688 "username" : {
8689 "description" : "Username or API token ID on the Proxmox Backup Server",
8690 "maxLength" : 512,
8691 "minLength" : 3,
8692 "optional" : 1,
8693 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
8694 "type" : "string"
8695 }
8696 },
8697 "type" : "object"
8698 },
8699 "permissions" : {
8700 "check" : [
8701 "admin"
8702 ]
8703 },
8704 "protected" : 1,
8705 "proxyto" : "master",
8706 "returns" : {
8707 "type" : "null"
8708 }
8709 }
8710 },
8711 "leaf" : 1,
8712 "path" : "/config/pbs/{remote}",
8713 "text" : "{remote}"
8714 }
8715 ],
8716 "info" : {
8717 "GET" : {
8718 "allowtoken" : 1,
8719 "description" : "List all configured Proxmox Backup Server instances.",
8720 "method" : "GET",
8721 "name" : "list",
8722 "parameters" : {
8723 "additionalProperties" : 0
8724 },
8725 "permissions" : {
8726 "check" : [
8727 "admin",
8728 "audit"
8729 ]
8730 },
8731 "protected" : 1,
8732 "proxyto" : "master",
8733 "returns" : {
8734 "items" : {
8735 "additionalProperties" : 0,
8736 "properties" : {
8737 "datastore" : {
8738 "description" : "Proxmox Backup Server datastore name.",
8739 "optional" : 0,
8740 "type" : "string"
8741 },
8742 "disable" : {
8743 "description" : "Flag to disable (deactivate) the entry.",
8744 "optional" : 1,
8745 "type" : "boolean"
8746 },
8747 "fingerprint" : {
8748 "description" : "Certificate SHA 256 fingerprint.",
8749 "optional" : 1,
8750 "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}",
8751 "type" : "string"
8752 },
8753 "include-statistics" : {
8754 "description" : "Include statistics in scheduled backups",
8755 "optional" : 1,
8756 "type" : "boolean"
8757 },
8758 "keep-daily" : {
8759 "description" : "Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.",
8760 "format_description" : "N",
8761 "minimum" : "0",
8762 "optional" : 1,
8763 "type" : "integer"
8764 },
8765 "keep-hourly" : {
8766 "description" : "Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.",
8767 "format_description" : "N",
8768 "minimum" : "0",
8769 "optional" : 1,
8770 "type" : "integer"
8771 },
8772 "keep-last" : {
8773 "description" : "Keep the last <N> backups.",
8774 "format_description" : "N",
8775 "minimum" : "0",
8776 "optional" : 1,
8777 "type" : "integer"
8778 },
8779 "keep-monthly" : {
8780 "description" : "Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.",
8781 "format_description" : "N",
8782 "minimum" : "0",
8783 "optional" : 1,
8784 "type" : "integer"
8785 },
8786 "keep-weekly" : {
8787 "description" : "Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.",
8788 "format_description" : "N",
8789 "minimum" : "0",
8790 "optional" : 1,
8791 "type" : "integer"
8792 },
8793 "keep-yearly" : {
8794 "description" : "Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.",
8795 "format_description" : "N",
8796 "minimum" : "0",
8797 "optional" : 1,
8798 "type" : "integer"
8799 },
8800 "notify" : {
8801 "description" : "Specify when to notify via e-mail",
8802 "enum" : [
8803 "always",
8804 "error",
8805 "never"
8806 ],
8807 "optional" : 1,
8808 "type" : "string"
8809 },
8810 "password" : {
8811 "description" : "Password or API token secret for the user on the Proxmox Backup Server.",
8812 "optional" : 1,
8813 "type" : "string"
8814 },
8815 "remote" : {
8816 "description" : "Proxmox Backup Server ID.",
8817 "format" : "pve-configid",
8818 "type" : "string"
8819 },
8820 "server" : {
8821 "description" : "Proxmox Backup Server address.",
8822 "format" : "address",
8823 "maxLength" : 256,
8824 "optional" : 0,
8825 "type" : "string"
8826 },
8827 "username" : {
8828 "description" : "Username or API token ID on the Proxmox Backup Server",
8829 "maxLength" : 512,
8830 "minLength" : 3,
8831 "optional" : 1,
8832 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
8833 "type" : "string"
8834 }
8835 },
8836 "type" : "object"
8837 },
8838 "links" : [
8839 {
8840 "href" : "{remote}",
8841 "rel" : "child"
8842 }
8843 ],
8844 "type" : "array"
8845 }
8846 },
8847 "POST" : {
8848 "allowtoken" : 1,
8849 "description" : "Add Proxmox Backup Server remote instance.",
8850 "method" : "POST",
8851 "name" : "create",
8852 "parameters" : {
8853 "additionalProperties" : 0,
8854 "properties" : {
8855 "datastore" : {
8856 "description" : "Proxmox Backup Server datastore name.",
8857 "optional" : 0,
8858 "type" : "string",
8859 "typetext" : "<string>"
8860 },
8861 "disable" : {
8862 "description" : "Flag to disable (deactivate) the entry.",
8863 "optional" : 1,
8864 "type" : "boolean",
8865 "typetext" : "<boolean>"
8866 },
8867 "fingerprint" : {
8868 "description" : "Certificate SHA 256 fingerprint.",
8869 "optional" : 1,
8870 "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}",
8871 "type" : "string"
8872 },
8873 "include-statistics" : {
8874 "description" : "Include statistics in scheduled backups",
8875 "optional" : 1,
8876 "type" : "boolean",
8877 "typetext" : "<boolean>"
8878 },
8879 "keep-daily" : {
8880 "description" : "Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.",
8881 "format_description" : "N",
8882 "minimum" : "0",
8883 "optional" : 1,
8884 "type" : "integer",
8885 "typetext" : "<N>"
8886 },
8887 "keep-hourly" : {
8888 "description" : "Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.",
8889 "format_description" : "N",
8890 "minimum" : "0",
8891 "optional" : 1,
8892 "type" : "integer",
8893 "typetext" : "<N>"
8894 },
8895 "keep-last" : {
8896 "description" : "Keep the last <N> backups.",
8897 "format_description" : "N",
8898 "minimum" : "0",
8899 "optional" : 1,
8900 "type" : "integer",
8901 "typetext" : "<N>"
8902 },
8903 "keep-monthly" : {
8904 "description" : "Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.",
8905 "format_description" : "N",
8906 "minimum" : "0",
8907 "optional" : 1,
8908 "type" : "integer",
8909 "typetext" : "<N>"
8910 },
8911 "keep-weekly" : {
8912 "description" : "Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.",
8913 "format_description" : "N",
8914 "minimum" : "0",
8915 "optional" : 1,
8916 "type" : "integer",
8917 "typetext" : "<N>"
8918 },
8919 "keep-yearly" : {
8920 "description" : "Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.",
8921 "format_description" : "N",
8922 "minimum" : "0",
8923 "optional" : 1,
8924 "type" : "integer",
8925 "typetext" : "<N>"
8926 },
8927 "notify" : {
8928 "description" : "Specify when to notify via e-mail",
8929 "enum" : [
8930 "always",
8931 "error",
8932 "never"
8933 ],
8934 "optional" : 1,
8935 "type" : "string"
8936 },
8937 "password" : {
8938 "description" : "Password or API token secret for the user on the Proxmox Backup Server.",
8939 "optional" : 1,
8940 "type" : "string",
8941 "typetext" : "<string>"
8942 },
8943 "remote" : {
8944 "description" : "Proxmox Backup Server ID.",
8945 "format" : "pve-configid",
8946 "type" : "string",
8947 "typetext" : "<string>"
8948 },
8949 "server" : {
8950 "description" : "Proxmox Backup Server address.",
8951 "format" : "address",
8952 "maxLength" : 256,
8953 "optional" : 0,
8954 "type" : "string",
8955 "typetext" : "<string>"
8956 },
8957 "username" : {
8958 "description" : "Username or API token ID on the Proxmox Backup Server",
8959 "maxLength" : 512,
8960 "minLength" : 3,
8961 "optional" : 1,
8962 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
8963 "type" : "string"
8964 }
8965 },
8966 "type" : "object"
8967 },
8968 "permissions" : {
8969 "check" : [
8970 "admin"
8971 ]
8972 },
8973 "protected" : 1,
8974 "proxyto" : "master",
8975 "returns" : {
8976 "type" : "null"
8977 }
8978 }
8979 },
8980 "leaf" : 0,
8981 "path" : "/config/pbs",
8982 "text" : "pbs"
8983 },
8984 {
8985 "children" : [
8986 {
8987 "children" : [
8988 {
8989 "info" : {
8990 "DELETE" : {
8991 "allowtoken" : 1,
8992 "description" : "Delete ACME plugin configuration.",
8993 "method" : "DELETE",
8994 "name" : "delete_plugin",
8995 "parameters" : {
8996 "additionalProperties" : 0,
8997 "properties" : {
8998 "id" : {
8999 "description" : "Unique identifier for ACME plugin instance.",
9000 "format" : "pve-configid",
9001 "type" : "string",
9002 "typetext" : "<string>"
9003 }
9004 }
9005 },
9006 "permissions" : {
9007 "check" : [
9008 "admin"
9009 ]
9010 },
9011 "protected" : 1,
9012 "returns" : {
9013 "type" : "null"
9014 }
9015 },
9016 "GET" : {
9017 "allowtoken" : 1,
9018 "description" : "Get ACME plugin configuration.",
9019 "method" : "GET",
9020 "name" : "get_plugin_config",
9021 "parameters" : {
9022 "additionalProperties" : 0,
9023 "properties" : {
9024 "id" : {
9025 "description" : "Unique identifier for ACME plugin instance.",
9026 "format" : "pve-configid",
9027 "type" : "string",
9028 "typetext" : "<string>"
9029 }
9030 }
9031 },
9032 "permissions" : {
9033 "check" : [
9034 "admin"
9035 ]
9036 },
9037 "protected" : 1,
9038 "returns" : {
9039 "type" : "object"
9040 }
9041 },
9042 "PUT" : {
9043 "allowtoken" : 1,
9044 "description" : "Update ACME plugin configuration.",
9045 "method" : "PUT",
9046 "name" : "update_plugin",
9047 "parameters" : {
9048 "additionalProperties" : 0,
9049 "properties" : {
9050 "api" : {
9051 "description" : "API plugin name",
9052 "enum" : [
9053 "1984hosting",
9054 "acmedns",
9055 "acmeproxy",
9056 "active24",
9057 "ad",
9058 "ali",
9059 "anx",
9060 "arvan",
9061 "aurora",
9062 "autodns",
9063 "aws",
9064 "azure",
9065 "cf",
9066 "clouddns",
9067 "cloudns",
9068 "cn",
9069 "conoha",
9070 "constellix",
9071 "cx",
9072 "cyon",
9073 "da",
9074 "ddnss",
9075 "desec",
9076 "df",
9077 "dgon",
9078 "dnsimple",
9079 "do",
9080 "doapi",
9081 "domeneshop",
9082 "dp",
9083 "dpi",
9084 "dreamhost",
9085 "duckdns",
9086 "durabledns",
9087 "dyn",
9088 "dynu",
9089 "dynv6",
9090 "easydns",
9091 "edgedns",
9092 "euserv",
9093 "exoscale",
9094 "freedns",
9095 "gandi_livedns",
9096 "gcloud",
9097 "gd",
9098 "gdnsdk",
9099 "he",
9100 "hetzner",
9101 "hexonet",
9102 "hostingde",
9103 "huaweicloud",
9104 "infoblox",
9105 "infomaniak",
9106 "internetbs",
9107 "inwx",
9108 "ionos",
9109 "ispconfig",
9110 "jd",
9111 "joker",
9112 "kappernet",
9113 "kas",
9114 "kinghost",
9115 "knot",
9116 "leaseweb",
9117 "lexicon",
9118 "linode",
9119 "linode_v4",
9120 "loopia",
9121 "lua",
9122 "maradns",
9123 "me",
9124 "miab",
9125 "misaka",
9126 "myapi",
9127 "mydevil",
9128 "mydnsjp",
9129 "namecheap",
9130 "namecom",
9131 "namesilo",
9132 "nederhost",
9133 "neodigit",
9134 "netcup",
9135 "netlify",
9136 "nic",
9137 "njalla",
9138 "nm",
9139 "nsd",
9140 "nsone",
9141 "nsupdate",
9142 "nw",
9143 "one",
9144 "online",
9145 "openprovider",
9146 "openstack",
9147 "opnsense",
9148 "ovh",
9149 "pdns",
9150 "pleskxml",
9151 "pointhq",
9152 "porkbun",
9153 "rackcorp",
9154 "rackspace",
9155 "rcode0",
9156 "regru",
9157 "scaleway",
9158 "schlundtech",
9159 "selectel",
9160 "servercow",
9161 "simply",
9162 "tele3",
9163 "transip",
9164 "ultra",
9165 "unoeuro",
9166 "variomedia",
9167 "vscale",
9168 "vultr",
9169 "websupport",
9170 "world4you",
9171 "yandex",
9172 "zilore",
9173 "zone",
9174 "zonomi"
9175 ],
9176 "optional" : 1,
9177 "type" : "string"
9178 },
9179 "data" : {
9180 "description" : "DNS plugin data. (base64 encoded)",
9181 "optional" : 1,
9182 "type" : "string",
9183 "typetext" : "<string>"
9184 },
9185 "delete" : {
9186 "description" : "A list of settings you want to delete.",
9187 "format" : "pve-configid-list",
9188 "maxLength" : 4096,
9189 "optional" : 1,
9190 "type" : "string",
9191 "typetext" : "<string>"
9192 },
9193 "digest" : {
9194 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
9195 "maxLength" : 40,
9196 "optional" : 1,
9197 "type" : "string",
9198 "typetext" : "<string>"
9199 },
9200 "disable" : {
9201 "description" : "Flag to disable the config.",
9202 "optional" : 1,
9203 "type" : "boolean",
9204 "typetext" : "<boolean>"
9205 },
9206 "id" : {
9207 "description" : "ACME Plugin ID name",
9208 "format" : "pve-configid",
9209 "type" : "string",
9210 "typetext" : "<string>"
9211 },
9212 "nodes" : {
9213 "description" : "List of cluster node names.",
9214 "format" : "pve-node-list",
9215 "optional" : 1,
9216 "type" : "string",
9217 "typetext" : "<string>"
9218 },
9219 "validation-delay" : {
9220 "default" : 30,
9221 "description" : "Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.",
9222 "maximum" : 172800,
9223 "minimum" : 0,
9224 "optional" : 1,
9225 "type" : "integer",
9226 "typetext" : "<integer> (0 - 172800)"
9227 }
9228 },
9229 "type" : "object"
9230 },
9231 "permissions" : {
9232 "check" : [
9233 "admin"
9234 ]
9235 },
9236 "protected" : 1,
9237 "returns" : {
9238 "type" : "null"
9239 }
9240 }
9241 },
9242 "leaf" : 1,
9243 "path" : "/config/acme/plugins/{id}",
9244 "text" : "{id}"
9245 }
9246 ],
9247 "info" : {
9248 "GET" : {
9249 "allowtoken" : 1,
9250 "description" : "ACME plugin index.",
9251 "method" : "GET",
9252 "name" : "index",
9253 "parameters" : {
9254 "additionalProperties" : 0,
9255 "properties" : {
9256 "type" : {
9257 "description" : "Only list ACME plugins of a specific type",
9258 "enum" : [
9259 "dns",
9260 "standalone"
9261 ],
9262 "optional" : 1,
9263 "type" : "string"
9264 }
9265 }
9266 },
9267 "permissions" : {
9268 "check" : [
9269 "admin"
9270 ]
9271 },
9272 "protected" : 1,
9273 "returns" : {
9274 "items" : {
9275 "properties" : {
9276 "plugin" : {
9277 "description" : "Unique identifier for ACME plugin instance.",
9278 "format" : "pve-configid",
9279 "type" : "string"
9280 }
9281 },
9282 "type" : "object"
9283 },
9284 "links" : [
9285 {
9286 "href" : "{plugin}",
9287 "rel" : "child"
9288 }
9289 ],
9290 "type" : "array"
9291 }
9292 },
9293 "POST" : {
9294 "allowtoken" : 1,
9295 "description" : "Add ACME plugin configuration.",
9296 "method" : "POST",
9297 "name" : "add_plugin",
9298 "parameters" : {
9299 "additionalProperties" : 0,
9300 "properties" : {
9301 "api" : {
9302 "description" : "API plugin name",
9303 "enum" : [
9304 "1984hosting",
9305 "acmedns",
9306 "acmeproxy",
9307 "active24",
9308 "ad",
9309 "ali",
9310 "anx",
9311 "arvan",
9312 "aurora",
9313 "autodns",
9314 "aws",
9315 "azure",
9316 "cf",
9317 "clouddns",
9318 "cloudns",
9319 "cn",
9320 "conoha",
9321 "constellix",
9322 "cx",
9323 "cyon",
9324 "da",
9325 "ddnss",
9326 "desec",
9327 "df",
9328 "dgon",
9329 "dnsimple",
9330 "do",
9331 "doapi",
9332 "domeneshop",
9333 "dp",
9334 "dpi",
9335 "dreamhost",
9336 "duckdns",
9337 "durabledns",
9338 "dyn",
9339 "dynu",
9340 "dynv6",
9341 "easydns",
9342 "edgedns",
9343 "euserv",
9344 "exoscale",
9345 "freedns",
9346 "gandi_livedns",
9347 "gcloud",
9348 "gd",
9349 "gdnsdk",
9350 "he",
9351 "hetzner",
9352 "hexonet",
9353 "hostingde",
9354 "huaweicloud",
9355 "infoblox",
9356 "infomaniak",
9357 "internetbs",
9358 "inwx",
9359 "ionos",
9360 "ispconfig",
9361 "jd",
9362 "joker",
9363 "kappernet",
9364 "kas",
9365 "kinghost",
9366 "knot",
9367 "leaseweb",
9368 "lexicon",
9369 "linode",
9370 "linode_v4",
9371 "loopia",
9372 "lua",
9373 "maradns",
9374 "me",
9375 "miab",
9376 "misaka",
9377 "myapi",
9378 "mydevil",
9379 "mydnsjp",
9380 "namecheap",
9381 "namecom",
9382 "namesilo",
9383 "nederhost",
9384 "neodigit",
9385 "netcup",
9386 "netlify",
9387 "nic",
9388 "njalla",
9389 "nm",
9390 "nsd",
9391 "nsone",
9392 "nsupdate",
9393 "nw",
9394 "one",
9395 "online",
9396 "openprovider",
9397 "openstack",
9398 "opnsense",
9399 "ovh",
9400 "pdns",
9401 "pleskxml",
9402 "pointhq",
9403 "porkbun",
9404 "rackcorp",
9405 "rackspace",
9406 "rcode0",
9407 "regru",
9408 "scaleway",
9409 "schlundtech",
9410 "selectel",
9411 "servercow",
9412 "simply",
9413 "tele3",
9414 "transip",
9415 "ultra",
9416 "unoeuro",
9417 "variomedia",
9418 "vscale",
9419 "vultr",
9420 "websupport",
9421 "world4you",
9422 "yandex",
9423 "zilore",
9424 "zone",
9425 "zonomi"
9426 ],
9427 "optional" : 1,
9428 "type" : "string"
9429 },
9430 "data" : {
9431 "description" : "DNS plugin data. (base64 encoded)",
9432 "optional" : 1,
9433 "type" : "string",
9434 "typetext" : "<string>"
9435 },
9436 "disable" : {
9437 "description" : "Flag to disable the config.",
9438 "optional" : 1,
9439 "type" : "boolean",
9440 "typetext" : "<boolean>"
9441 },
9442 "id" : {
9443 "description" : "ACME Plugin ID name",
9444 "format" : "pve-configid",
9445 "type" : "string",
9446 "typetext" : "<string>"
9447 },
9448 "nodes" : {
9449 "description" : "List of cluster node names.",
9450 "format" : "pve-node-list",
9451 "optional" : 1,
9452 "type" : "string",
9453 "typetext" : "<string>"
9454 },
9455 "type" : {
9456 "description" : "ACME challenge type.",
9457 "enum" : [
9458 "dns",
9459 "standalone"
9460 ],
9461 "type" : "string"
9462 },
9463 "validation-delay" : {
9464 "default" : 30,
9465 "description" : "Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.",
9466 "maximum" : 172800,
9467 "minimum" : 0,
9468 "optional" : 1,
9469 "type" : "integer",
9470 "typetext" : "<integer> (0 - 172800)"
9471 }
9472 },
9473 "type" : "object"
9474 },
9475 "permissions" : {
9476 "check" : [
9477 "admin"
9478 ]
9479 },
9480 "protected" : 1,
9481 "returns" : {
9482 "type" : "null"
9483 }
9484 }
9485 },
9486 "leaf" : 0,
9487 "path" : "/config/acme/plugins",
9488 "text" : "plugins"
9489 },
9490 {
9491 "children" : [
9492 {
9493 "info" : {
9494 "DELETE" : {
9495 "allowtoken" : 1,
9496 "description" : "Deactivate existing ACME account at CA.",
9497 "method" : "DELETE",
9498 "name" : "deactivate_account",
9499 "parameters" : {
9500 "additionalProperties" : 0,
9501 "properties" : {
9502 "force" : {
9503 "default" : 0,
9504 "description" : "Delete account data even if the server refuses to deactivate the account.",
9505 "optional" : 1,
9506 "type" : "boolean",
9507 "typetext" : "<boolean>"
9508 },
9509 "name" : {
9510 "default" : "default",
9511 "description" : "ACME account config file name.",
9512 "format" : "pve-configid",
9513 "format_description" : "name",
9514 "optional" : 1,
9515 "type" : "string",
9516 "typetext" : "<name>"
9517 }
9518 }
9519 },
9520 "permissions" : {
9521 "check" : [
9522 "admin"
9523 ]
9524 },
9525 "protected" : 1,
9526 "proxyto" : "master",
9527 "returns" : {
9528 "type" : "string"
9529 }
9530 },
9531 "GET" : {
9532 "allowtoken" : 1,
9533 "description" : "Return existing ACME account information.",
9534 "method" : "GET",
9535 "name" : "get_account",
9536 "parameters" : {
9537 "additionalProperties" : 0,
9538 "properties" : {
9539 "name" : {
9540 "default" : "default",
9541 "description" : "ACME account config file name.",
9542 "format" : "pve-configid",
9543 "format_description" : "name",
9544 "optional" : 1,
9545 "type" : "string",
9546 "typetext" : "<name>"
9547 }
9548 }
9549 },
9550 "protected" : 1,
9551 "proxyto" : "master",
9552 "returns" : {
9553 "additionalProperties" : 0,
9554 "properties" : {
9555 "account" : {
9556 "optional" : 1,
9557 "renderer" : "yaml",
9558 "type" : "object"
9559 },
9560 "directory" : {
9561 "description" : "URL of ACME CA directory endpoint.",
9562 "optional" : 1,
9563 "pattern" : "^https?://.*",
9564 "type" : "string"
9565 },
9566 "location" : {
9567 "optional" : 1,
9568 "type" : "string"
9569 },
9570 "tos" : {
9571 "optional" : 1,
9572 "type" : "string"
9573 }
9574 },
9575 "type" : "object"
9576 }
9577 },
9578 "PUT" : {
9579 "allowtoken" : 1,
9580 "description" : "Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh.",
9581 "method" : "PUT",
9582 "name" : "update_account",
9583 "parameters" : {
9584 "additionalProperties" : 0,
9585 "properties" : {
9586 "contact" : {
9587 "description" : "Contact email addresses.",
9588 "format" : "email-list",
9589 "optional" : 1,
9590 "type" : "string",
9591 "typetext" : "<string>"
9592 },
9593 "name" : {
9594 "default" : "default",
9595 "description" : "ACME account config file name.",
9596 "format" : "pve-configid",
9597 "format_description" : "name",
9598 "optional" : 1,
9599 "type" : "string",
9600 "typetext" : "<name>"
9601 }
9602 }
9603 },
9604 "permissions" : {
9605 "check" : [
9606 "admin"
9607 ]
9608 },
9609 "protected" : 1,
9610 "proxyto" : "master",
9611 "returns" : {
9612 "type" : "string"
9613 }
9614 }
9615 },
9616 "leaf" : 1,
9617 "path" : "/config/acme/account/{name}",
9618 "text" : "{name}"
9619 }
9620 ],
9621 "info" : {
9622 "GET" : {
9623 "allowtoken" : 1,
9624 "description" : "ACME account index.",
9625 "method" : "GET",
9626 "name" : "account_index",
9627 "parameters" : {
9628 "additionalProperties" : 0
9629 },
9630 "permissions" : {
9631 "check" : [
9632 "admin",
9633 "audit"
9634 ]
9635 },
9636 "protected" : 1,
9637 "returns" : {
9638 "items" : {
9639 "properties" : {},
9640 "type" : "object"
9641 },
9642 "links" : [
9643 {
9644 "href" : "{name}",
9645 "rel" : "child"
9646 }
9647 ],
9648 "type" : "array"
9649 }
9650 },
9651 "POST" : {
9652 "allowtoken" : 1,
9653 "description" : "Register a new ACME account with CA.",
9654 "method" : "POST",
9655 "name" : "register_account",
9656 "parameters" : {
9657 "additionalProperties" : 0,
9658 "properties" : {
9659 "contact" : {
9660 "description" : "Contact email addresses.",
9661 "format" : "email-list",
9662 "type" : "string",
9663 "typetext" : "<string>"
9664 },
9665 "directory" : {
9666 "default" : "https://acme-v02.api.letsencrypt.org/directory",
9667 "description" : "URL of ACME CA directory endpoint.",
9668 "optional" : 1,
9669 "pattern" : "^https?://.*",
9670 "type" : "string"
9671 },
9672 "name" : {
9673 "default" : "default",
9674 "description" : "ACME account config file name.",
9675 "format" : "pve-configid",
9676 "format_description" : "name",
9677 "optional" : 1,
9678 "type" : "string",
9679 "typetext" : "<name>"
9680 },
9681 "tos_url" : {
9682 "description" : "URL of CA TermsOfService - setting this indicates agreement.",
9683 "optional" : 1,
9684 "type" : "string",
9685 "typetext" : "<string>"
9686 }
9687 }
9688 },
9689 "permissions" : {
9690 "check" : [
9691 "admin"
9692 ]
9693 },
9694 "protected" : 1,
9695 "proxyto" : "master",
9696 "returns" : {
9697 "type" : "string"
9698 }
9699 }
9700 },
9701 "leaf" : 0,
9702 "path" : "/config/acme/account",
9703 "text" : "account"
9704 },
9705 {
9706 "info" : {
9707 "GET" : {
9708 "allowtoken" : 1,
9709 "description" : "Retrieve ACME TermsOfService URL from CA.",
9710 "method" : "GET",
9711 "name" : "get_tos",
9712 "parameters" : {
9713 "additionalProperties" : 0,
9714 "properties" : {
9715 "directory" : {
9716 "default" : "https://acme-v02.api.letsencrypt.org/directory",
9717 "description" : "URL of ACME CA directory endpoint.",
9718 "optional" : 1,
9719 "pattern" : "^https?://.*",
9720 "type" : "string"
9721 }
9722 }
9723 },
9724 "permissions" : {
9725 "user" : "all"
9726 },
9727 "returns" : {
9728 "description" : "ACME TermsOfService URL.",
9729 "optional" : 1,
9730 "type" : "string"
9731 }
9732 }
9733 },
9734 "leaf" : 1,
9735 "path" : "/config/acme/tos",
9736 "text" : "tos"
9737 },
9738 {
9739 "info" : {
9740 "GET" : {
9741 "allowtoken" : 1,
9742 "description" : "Get named known ACME directory endpoints.",
9743 "method" : "GET",
9744 "name" : "get_directories",
9745 "parameters" : {
9746 "additionalProperties" : 0
9747 },
9748 "permissions" : {
9749 "user" : "all"
9750 },
9751 "returns" : {
9752 "items" : {
9753 "additionalProperties" : 0,
9754 "properties" : {
9755 "name" : {
9756 "type" : "string"
9757 },
9758 "url" : {
9759 "description" : "URL of ACME CA directory endpoint.",
9760 "pattern" : "^https?://.*",
9761 "type" : "string"
9762 }
9763 },
9764 "type" : "object"
9765 },
9766 "type" : "array"
9767 }
9768 }
9769 },
9770 "leaf" : 1,
9771 "path" : "/config/acme/directories",
9772 "text" : "directories"
9773 },
9774 {
9775 "info" : {
9776 "GET" : {
9777 "allowtoken" : 1,
9778 "description" : "Get schema of ACME challenge types.",
9779 "method" : "GET",
9780 "name" : "challenge-schema",
9781 "parameters" : {
9782 "additionalProperties" : 0
9783 },
9784 "permissions" : {
9785 "user" : "all"
9786 },
9787 "returns" : {
9788 "items" : {
9789 "additionalProperties" : 0,
9790 "properties" : {
9791 "id" : {
9792 "type" : "string"
9793 },
9794 "name" : {
9795 "description" : "Human readable name, falls back to id",
9796 "type" : "string"
9797 },
9798 "schema" : {
9799 "type" : "object"
9800 },
9801 "type" : {
9802 "type" : "string"
9803 }
9804 },
9805 "type" : "object"
9806 },
9807 "type" : "array"
9808 }
9809 }
9810 },
9811 "leaf" : 1,
9812 "path" : "/config/acme/challenge-schema",
9813 "text" : "challenge-schema"
9814 }
9815 ],
9816 "info" : {
9817 "GET" : {
9818 "allowtoken" : 1,
9819 "description" : "ACME index.",
9820 "method" : "GET",
9821 "name" : "index",
9822 "parameters" : {
9823 "additionalProperties" : 0
9824 },
9825 "permissions" : {
9826 "user" : "all"
9827 },
9828 "returns" : {
9829 "items" : {
9830 "properties" : {},
9831 "type" : "object"
9832 },
9833 "links" : [
9834 {
9835 "href" : "{name}",
9836 "rel" : "child"
9837 }
9838 ],
9839 "type" : "array"
9840 }
9841 }
9842 },
9843 "leaf" : 0,
9844 "path" : "/config/acme",
9845 "text" : "acme"
9846 },
9847 {
9848 "info" : {
9849 "GET" : {
9850 "allowtoken" : 1,
9851 "description" : "Read admin configuration properties.",
9852 "method" : "GET",
9853 "name" : "read_admin_section",
9854 "parameters" : {
9855 "additionalProperties" : 0
9856 },
9857 "permissions" : {
9858 "check" : [
9859 "admin",
9860 "audit"
9861 ]
9862 },
9863 "proxyto" : "master",
9864 "returns" : {
9865 "type" : "object"
9866 }
9867 },
9868 "PUT" : {
9869 "allowtoken" : 1,
9870 "description" : "Update admin configuration properties.",
9871 "method" : "PUT",
9872 "name" : "update_admin_section",
9873 "parameters" : {
9874 "additionalProperties" : 0,
9875 "properties" : {
9876 "advfilter" : {
9877 "default" : 1,
9878 "description" : "Use advanced filters for statistic.",
9879 "optional" : 1,
9880 "type" : "boolean",
9881 "typetext" : "<boolean>"
9882 },
9883 "avast" : {
9884 "default" : 0,
9885 "description" : "Use Avast Virus Scanner (/usr/bin/scan). You need to buy and install 'Avast Core Security' before you can enable this feature.",
9886 "optional" : 1,
9887 "type" : "boolean",
9888 "typetext" : "<boolean>"
9889 },
9890 "clamav" : {
9891 "default" : 1,
9892 "description" : "Use ClamAV Virus Scanner. This is the default virus scanner and is enabled by default.",
9893 "optional" : 1,
9894 "type" : "boolean",
9895 "typetext" : "<boolean>"
9896 },
9897 "custom_check" : {
9898 "default" : 0,
9899 "description" : "Use Custom Check Script. The script has to take the defined arguments and can return Virus findings or a Spamscore.",
9900 "optional" : 1,
9901 "type" : "boolean",
9902 "typetext" : "<boolean>"
9903 },
9904 "custom_check_path" : {
9905 "default" : "/usr/local/bin/pmg-custom-check",
9906 "description" : "Absolute Path to the Custom Check Script",
9907 "optional" : 1,
9908 "pattern" : "^/([^/\\0]+\\/)+[^/\\0]+$",
9909 "type" : "string"
9910 },
9911 "dailyreport" : {
9912 "default" : 1,
9913 "description" : "Send daily reports.",
9914 "optional" : 1,
9915 "type" : "boolean",
9916 "typetext" : "<boolean>"
9917 },
9918 "delete" : {
9919 "description" : "A list of settings you want to delete.",
9920 "format" : "pve-configid-list",
9921 "maxLength" : 4096,
9922 "optional" : 1,
9923 "type" : "string",
9924 "typetext" : "<string>"
9925 },
9926 "demo" : {
9927 "default" : 0,
9928 "description" : "Demo mode - do not start SMTP filter.",
9929 "optional" : 1,
9930 "type" : "boolean",
9931 "typetext" : "<boolean>"
9932 },
9933 "digest" : {
9934 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
9935 "maxLength" : 40,
9936 "optional" : 1,
9937 "type" : "string",
9938 "typetext" : "<string>"
9939 },
9940 "dkim_selector" : {
9941 "description" : "Default DKIM selector",
9942 "format" : "dns-name",
9943 "optional" : 1,
9944 "type" : "string",
9945 "typetext" : "<string>"
9946 },
9947 "dkim_sign" : {
9948 "default" : 0,
9949 "description" : "DKIM sign outbound mails with the configured Selector.",
9950 "optional" : 1,
9951 "type" : "boolean",
9952 "typetext" : "<boolean>"
9953 },
9954 "dkim_sign_all_mail" : {
9955 "default" : 0,
9956 "description" : "DKIM sign all outgoing mails irrespective of the Envelope From domain.",
9957 "optional" : 1,
9958 "type" : "boolean",
9959 "typetext" : "<boolean>"
9960 },
9961 "email" : {
9962 "default" : "admin@domain.tld",
9963 "description" : "Administrator E-Mail address.",
9964 "format" : "email",
9965 "optional" : 1,
9966 "type" : "string",
9967 "typetext" : "<string>"
9968 },
9969 "http_proxy" : {
9970 "description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')",
9971 "optional" : 1,
9972 "pattern" : "http://.*",
9973 "type" : "string"
9974 },
9975 "statlifetime" : {
9976 "default" : 7,
9977 "description" : "User Statistics Lifetime (days)",
9978 "minimum" : 1,
9979 "optional" : 1,
9980 "type" : "integer",
9981 "typetext" : "<integer> (1 - N)"
9982 }
9983 },
9984 "type" : "object"
9985 },
9986 "permissions" : {
9987 "check" : [
9988 "admin"
9989 ]
9990 },
9991 "protected" : 1,
9992 "proxyto" : "master",
9993 "returns" : {
9994 "type" : "null"
9995 }
9996 }
9997 },
9998 "leaf" : 1,
9999 "path" : "/config/admin",
10000 "text" : "admin"
10001 },
10002 {
10003 "info" : {
10004 "GET" : {
10005 "allowtoken" : 1,
10006 "description" : "Read clamav configuration properties.",
10007 "method" : "GET",
10008 "name" : "read_clamav_section",
10009 "parameters" : {
10010 "additionalProperties" : 0
10011 },
10012 "permissions" : {
10013 "check" : [
10014 "admin",
10015 "audit"
10016 ]
10017 },
10018 "proxyto" : "master",
10019 "returns" : {
10020 "type" : "object"
10021 }
10022 },
10023 "PUT" : {
10024 "allowtoken" : 1,
10025 "description" : "Update clamav configuration properties.",
10026 "method" : "PUT",
10027 "name" : "update_clamav_section",
10028 "parameters" : {
10029 "additionalProperties" : 0,
10030 "properties" : {
10031 "archiveblockencrypted" : {
10032 "default" : 0,
10033 "description" : "Whether to mark encrypted archives and documents as heuristic virus match. A match does not necessarily result in an immediate block, it just raises the Spam Score by 'clamav_heuristic_score'.",
10034 "optional" : 1,
10035 "type" : "boolean",
10036 "typetext" : "<boolean>"
10037 },
10038 "archivemaxfiles" : {
10039 "default" : 1000,
10040 "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.",
10041 "minimum" : 0,
10042 "optional" : 1,
10043 "type" : "integer",
10044 "typetext" : "<integer> (0 - N)"
10045 },
10046 "archivemaxrec" : {
10047 "default" : 5,
10048 "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.",
10049 "minimum" : 1,
10050 "optional" : 1,
10051 "type" : "integer",
10052 "typetext" : "<integer> (1 - N)"
10053 },
10054 "archivemaxsize" : {
10055 "default" : 25000000,
10056 "description" : "Files larger than this limit (in bytes) won't be scanned.",
10057 "minimum" : 1000000,
10058 "optional" : 1,
10059 "type" : "integer",
10060 "typetext" : "<integer> (1000000 - N)"
10061 },
10062 "dbmirror" : {
10063 "default" : "database.clamav.net",
10064 "description" : "ClamAV database mirror server.",
10065 "optional" : 1,
10066 "type" : "string",
10067 "typetext" : "<string>"
10068 },
10069 "delete" : {
10070 "description" : "A list of settings you want to delete.",
10071 "format" : "pve-configid-list",
10072 "maxLength" : 4096,
10073 "optional" : 1,
10074 "type" : "string",
10075 "typetext" : "<string>"
10076 },
10077 "digest" : {
10078 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
10079 "maxLength" : 40,
10080 "optional" : 1,
10081 "type" : "string",
10082 "typetext" : "<string>"
10083 },
10084 "maxcccount" : {
10085 "default" : 0,
10086 "description" : "This option sets the lowest number of Credit Card or Social Security numbers found in a file to generate a detect.",
10087 "minimum" : 0,
10088 "optional" : 1,
10089 "type" : "integer",
10090 "typetext" : "<integer> (0 - N)"
10091 },
10092 "maxscansize" : {
10093 "default" : 100000000,
10094 "description" : "Sets the maximum amount of data (in bytes) to be scanned for each input file.",
10095 "minimum" : 1000000,
10096 "optional" : 1,
10097 "type" : "integer",
10098 "typetext" : "<integer> (1000000 - N)"
10099 },
10100 "safebrowsing" : {
10101 "default" : 0,
10102 "description" : "Enables support for Google Safe Browsing. (deprecated option, will be ignored)",
10103 "optional" : 1,
10104 "type" : "boolean",
10105 "typetext" : "<boolean>"
10106 },
10107 "scriptedupdates" : {
10108 "default" : 1,
10109 "description" : "Enables ScriptedUpdates (incremental download of signatures)",
10110 "optional" : 1,
10111 "type" : "boolean",
10112 "typetext" : "<boolean>"
10113 }
10114 },
10115 "type" : "object"
10116 },
10117 "permissions" : {
10118 "check" : [
10119 "admin"
10120 ]
10121 },
10122 "protected" : 1,
10123 "proxyto" : "master",
10124 "returns" : {
10125 "type" : "null"
10126 }
10127 }
10128 },
10129 "leaf" : 1,
10130 "path" : "/config/clamav",
10131 "text" : "clamav"
10132 },
10133 {
10134 "info" : {
10135 "GET" : {
10136 "allowtoken" : 1,
10137 "description" : "Read mail configuration properties.",
10138 "method" : "GET",
10139 "name" : "read_mail_section",
10140 "parameters" : {
10141 "additionalProperties" : 0
10142 },
10143 "permissions" : {
10144 "check" : [
10145 "admin",
10146 "audit"
10147 ]
10148 },
10149 "proxyto" : "master",
10150 "returns" : {
10151 "type" : "object"
10152 }
10153 },
10154 "PUT" : {
10155 "allowtoken" : 1,
10156 "description" : "Update mail configuration properties.",
10157 "method" : "PUT",
10158 "name" : "update_mail_section",
10159 "parameters" : {
10160 "additionalProperties" : 0,
10161 "properties" : {
10162 "banner" : {
10163 "default" : "ESMTP Proxmox",
10164 "description" : "ESMTP banner.",
10165 "maxLength" : 1024,
10166 "optional" : 1,
10167 "type" : "string",
10168 "typetext" : "<string>"
10169 },
10170 "before_queue_filtering" : {
10171 "default" : 0,
10172 "description" : "Enable before queue filtering by pmg-smtp-filter",
10173 "optional" : 1,
10174 "type" : "boolean",
10175 "typetext" : "<boolean>"
10176 },
10177 "conn_count_limit" : {
10178 "default" : 50,
10179 "description" : "How many simultaneous connections any client is allowed to make to this service. To disable this feature, specify a limit of 0.",
10180 "minimum" : 0,
10181 "optional" : 1,
10182 "type" : "integer",
10183 "typetext" : "<integer> (0 - N)"
10184 },
10185 "conn_rate_limit" : {
10186 "default" : 0,
10187 "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.",
10188 "minimum" : 0,
10189 "optional" : 1,
10190 "type" : "integer",
10191 "typetext" : "<integer> (0 - N)"
10192 },
10193 "delete" : {
10194 "description" : "A list of settings you want to delete.",
10195 "format" : "pve-configid-list",
10196 "maxLength" : 4096,
10197 "optional" : 1,
10198 "type" : "string",
10199 "typetext" : "<string>"
10200 },
10201 "digest" : {
10202 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
10203 "maxLength" : 40,
10204 "optional" : 1,
10205 "type" : "string",
10206 "typetext" : "<string>"
10207 },
10208 "dnsbl_sites" : {
10209 "description" : "Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).",
10210 "format" : "dnsbl-entry-list",
10211 "optional" : 1,
10212 "type" : "string",
10213 "typetext" : "<string>"
10214 },
10215 "dnsbl_threshold" : {
10216 "default" : 1,
10217 "description" : "The inclusive lower bound for blocking a remote SMTP client, based on its combined DNSBL score (see postscreen_dnsbl_threshold parameter).",
10218 "minimum" : 0,
10219 "optional" : 1,
10220 "type" : "integer",
10221 "typetext" : "<integer> (0 - N)"
10222 },
10223 "dwarning" : {
10224 "default" : 4,
10225 "description" : "SMTP delay warning time (in hours).",
10226 "minimum" : 0,
10227 "optional" : 1,
10228 "type" : "integer",
10229 "typetext" : "<integer> (0 - N)"
10230 },
10231 "ext_port" : {
10232 "default" : 25,
10233 "description" : "SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.",
10234 "maximum" : 65535,
10235 "minimum" : 1,
10236 "optional" : 1,
10237 "type" : "integer",
10238 "typetext" : "<integer> (1 - 65535)"
10239 },
10240 "greylist" : {
10241 "default" : 1,
10242 "description" : "Use Greylisting for IPv4.",
10243 "optional" : 1,
10244 "type" : "boolean",
10245 "typetext" : "<boolean>"
10246 },
10247 "greylist6" : {
10248 "default" : 0,
10249 "description" : "Use Greylisting for IPv6.",
10250 "optional" : 1,
10251 "type" : "boolean",
10252 "typetext" : "<boolean>"
10253 },
10254 "greylistmask4" : {
10255 "default" : 24,
10256 "description" : "Netmask to apply for greylisting IPv4 hosts",
10257 "maximum" : 32,
10258 "minimum" : 0,
10259 "optional" : 1,
10260 "type" : "integer",
10261 "typetext" : "<integer> (0 - 32)"
10262 },
10263 "greylistmask6" : {
10264 "default" : 64,
10265 "description" : "Netmask to apply for greylisting IPv6 hosts",
10266 "maximum" : 128,
10267 "minimum" : 0,
10268 "optional" : 1,
10269 "type" : "integer",
10270 "typetext" : "<integer> (0 - 128)"
10271 },
10272 "helotests" : {
10273 "default" : 0,
10274 "description" : "Use SMTP HELO tests.",
10275 "optional" : 1,
10276 "type" : "boolean",
10277 "typetext" : "<boolean>"
10278 },
10279 "hide_received" : {
10280 "default" : 0,
10281 "description" : "Hide received header in outgoing mails.",
10282 "optional" : 1,
10283 "type" : "boolean",
10284 "typetext" : "<boolean>"
10285 },
10286 "int_port" : {
10287 "default" : 26,
10288 "description" : "SMTP port number for outgoing mail (trusted).",
10289 "maximum" : 65535,
10290 "minimum" : 1,
10291 "optional" : 1,
10292 "type" : "integer",
10293 "typetext" : "<integer> (1 - 65535)"
10294 },
10295 "max_filters" : {
10296 "default" : 38,
10297 "description" : "Maximum number of pmg-smtp-filter processes.",
10298 "maximum" : 40,
10299 "minimum" : 3,
10300 "optional" : 1,
10301 "type" : "integer",
10302 "typetext" : "<integer> (3 - 40)"
10303 },
10304 "max_policy" : {
10305 "default" : 5,
10306 "description" : "Maximum number of pmgpolicy processes.",
10307 "maximum" : 10,
10308 "minimum" : 2,
10309 "optional" : 1,
10310 "type" : "integer",
10311 "typetext" : "<integer> (2 - 10)"
10312 },
10313 "max_smtpd_in" : {
10314 "default" : 100,
10315 "description" : "Maximum number of SMTP daemon processes (in).",
10316 "maximum" : 100,
10317 "minimum" : 3,
10318 "optional" : 1,
10319 "type" : "integer",
10320 "typetext" : "<integer> (3 - 100)"
10321 },
10322 "max_smtpd_out" : {
10323 "default" : 100,
10324 "description" : "Maximum number of SMTP daemon processes (out).",
10325 "maximum" : 100,
10326 "minimum" : 3,
10327 "optional" : 1,
10328 "type" : "integer",
10329 "typetext" : "<integer> (3 - 100)"
10330 },
10331 "maxsize" : {
10332 "default" : 10485760,
10333 "description" : "Maximum email size. Larger mails are rejected.",
10334 "minimum" : 1024,
10335 "optional" : 1,
10336 "type" : "integer",
10337 "typetext" : "<integer> (1024 - N)"
10338 },
10339 "message_rate_limit" : {
10340 "default" : 0,
10341 "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.",
10342 "minimum" : 0,
10343 "optional" : 1,
10344 "type" : "integer",
10345 "typetext" : "<integer> (0 - N)"
10346 },
10347 "ndr_on_block" : {
10348 "default" : 0,
10349 "description" : "Send out NDR when mail gets blocked",
10350 "optional" : 1,
10351 "type" : "boolean",
10352 "typetext" : "<boolean>"
10353 },
10354 "rejectunknown" : {
10355 "default" : 0,
10356 "description" : "Reject unknown clients.",
10357 "optional" : 1,
10358 "type" : "boolean",
10359 "typetext" : "<boolean>"
10360 },
10361 "rejectunknownsender" : {
10362 "default" : 0,
10363 "description" : "Reject unknown senders.",
10364 "optional" : 1,
10365 "type" : "boolean",
10366 "typetext" : "<boolean>"
10367 },
10368 "relay" : {
10369 "description" : "The default mail delivery transport (incoming mails).",
10370 "format" : "address",
10371 "optional" : 1,
10372 "type" : "string",
10373 "typetext" : "<string>"
10374 },
10375 "relaynomx" : {
10376 "default" : 0,
10377 "description" : "Disable MX lookups for default relay (SMTP only, ignored for LMTP).",
10378 "optional" : 1,
10379 "type" : "boolean",
10380 "typetext" : "<boolean>"
10381 },
10382 "relayport" : {
10383 "default" : 25,
10384 "description" : "SMTP/LMTP port number for relay host.",
10385 "maximum" : 65535,
10386 "minimum" : 1,
10387 "optional" : 1,
10388 "type" : "integer",
10389 "typetext" : "<integer> (1 - 65535)"
10390 },
10391 "relayprotocol" : {
10392 "default" : "smtp",
10393 "description" : "Transport protocol for relay host.",
10394 "enum" : [
10395 "smtp",
10396 "lmtp"
10397 ],
10398 "optional" : 1,
10399 "type" : "string"
10400 },
10401 "smarthost" : {
10402 "description" : "When set, all outgoing mails are deliverd to the specified smarthost.",
10403 "format" : "address",
10404 "optional" : 1,
10405 "type" : "string",
10406 "typetext" : "<string>"
10407 },
10408 "smarthostport" : {
10409 "default" : 25,
10410 "description" : "SMTP port number for smarthost.",
10411 "maximum" : 65535,
10412 "minimum" : 1,
10413 "optional" : 1,
10414 "type" : "integer",
10415 "typetext" : "<integer> (1 - 65535)"
10416 },
10417 "spf" : {
10418 "default" : 1,
10419 "description" : "Use Sender Policy Framework.",
10420 "optional" : 1,
10421 "type" : "boolean",
10422 "typetext" : "<boolean>"
10423 },
10424 "tls" : {
10425 "default" : 0,
10426 "description" : "Enable TLS.",
10427 "optional" : 1,
10428 "type" : "boolean",
10429 "typetext" : "<boolean>"
10430 },
10431 "tlsheader" : {
10432 "default" : 0,
10433 "description" : "Add TLS received header.",
10434 "optional" : 1,
10435 "type" : "boolean",
10436 "typetext" : "<boolean>"
10437 },
10438 "tlslog" : {
10439 "default" : 0,
10440 "description" : "Enable TLS Logging.",
10441 "optional" : 1,
10442 "type" : "boolean",
10443 "typetext" : "<boolean>"
10444 },
10445 "verifyreceivers" : {
10446 "description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.",
10447 "enum" : [
10448 "450",
10449 "550"
10450 ],
10451 "optional" : 1,
10452 "type" : "string"
10453 }
10454 },
10455 "type" : "object"
10456 },
10457 "permissions" : {
10458 "check" : [
10459 "admin"
10460 ]
10461 },
10462 "protected" : 1,
10463 "proxyto" : "master",
10464 "returns" : {
10465 "type" : "null"
10466 }
10467 }
10468 },
10469 "leaf" : 1,
10470 "path" : "/config/mail",
10471 "text" : "mail"
10472 },
10473 {
10474 "info" : {
10475 "GET" : {
10476 "allowtoken" : 1,
10477 "description" : "Read spam configuration properties.",
10478 "method" : "GET",
10479 "name" : "read_spam_section",
10480 "parameters" : {
10481 "additionalProperties" : 0
10482 },
10483 "permissions" : {
10484 "check" : [
10485 "admin",
10486 "audit"
10487 ]
10488 },
10489 "proxyto" : "master",
10490 "returns" : {
10491 "type" : "object"
10492 }
10493 },
10494 "PUT" : {
10495 "allowtoken" : 1,
10496 "description" : "Update spam configuration properties.",
10497 "method" : "PUT",
10498 "name" : "update_spam_section",
10499 "parameters" : {
10500 "additionalProperties" : 0,
10501 "properties" : {
10502 "bounce_score" : {
10503 "default" : 0,
10504 "description" : "Additional score for bounce mails.",
10505 "maximum" : 1000,
10506 "minimum" : 0,
10507 "optional" : 1,
10508 "type" : "integer",
10509 "typetext" : "<integer> (0 - 1000)"
10510 },
10511 "clamav_heuristic_score" : {
10512 "default" : 3,
10513 "description" : "Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...).",
10514 "maximum" : 1000,
10515 "minimum" : 0,
10516 "optional" : 1,
10517 "type" : "integer",
10518 "typetext" : "<integer> (0 - 1000)"
10519 },
10520 "delete" : {
10521 "description" : "A list of settings you want to delete.",
10522 "format" : "pve-configid-list",
10523 "maxLength" : 4096,
10524 "optional" : 1,
10525 "type" : "string",
10526 "typetext" : "<string>"
10527 },
10528 "digest" : {
10529 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
10530 "maxLength" : 40,
10531 "optional" : 1,
10532 "type" : "string",
10533 "typetext" : "<string>"
10534 },
10535 "languages" : {
10536 "default" : "all",
10537 "description" : "This option is used to specify which languages are considered OK for incoming mail.",
10538 "optional" : 1,
10539 "pattern" : "(all|([a-z][a-z])+( ([a-z][a-z])+)*)",
10540 "type" : "string"
10541 },
10542 "maxspamsize" : {
10543 "default" : 262144,
10544 "description" : "Maximum size of spam messages in bytes.",
10545 "minimum" : 64,
10546 "optional" : 1,
10547 "type" : "integer",
10548 "typetext" : "<integer> (64 - N)"
10549 },
10550 "rbl_checks" : {
10551 "default" : 1,
10552 "description" : "Enable real time blacklists (RBL) checks.",
10553 "optional" : 1,
10554 "type" : "boolean",
10555 "typetext" : "<boolean>"
10556 },
10557 "use_awl" : {
10558 "default" : 1,
10559 "description" : "Use the Auto-Whitelist plugin.",
10560 "optional" : 1,
10561 "type" : "boolean",
10562 "typetext" : "<boolean>"
10563 },
10564 "use_bayes" : {
10565 "default" : 1,
10566 "description" : "Whether to use the naive-Bayesian-style classifier.",
10567 "optional" : 1,
10568 "type" : "boolean",
10569 "typetext" : "<boolean>"
10570 },
10571 "use_razor" : {
10572 "default" : 1,
10573 "description" : "Whether to use Razor2, if it is available.",
10574 "optional" : 1,
10575 "type" : "boolean",
10576 "typetext" : "<boolean>"
10577 },
10578 "wl_bounce_relays" : {
10579 "description" : "Whitelist legitimate bounce relays.",
10580 "optional" : 1,
10581 "type" : "string",
10582 "typetext" : "<string>"
10583 }
10584 },
10585 "type" : "object"
10586 },
10587 "permissions" : {
10588 "check" : [
10589 "admin"
10590 ]
10591 },
10592 "protected" : 1,
10593 "proxyto" : "master",
10594 "returns" : {
10595 "type" : "null"
10596 }
10597 }
10598 },
10599 "leaf" : 1,
10600 "path" : "/config/spam",
10601 "text" : "spam"
10602 },
10603 {
10604 "info" : {
10605 "GET" : {
10606 "allowtoken" : 1,
10607 "description" : "Read spamquar configuration properties.",
10608 "method" : "GET",
10609 "name" : "read_spamquar_section",
10610 "parameters" : {
10611 "additionalProperties" : 0
10612 },
10613 "permissions" : {
10614 "check" : [
10615 "admin",
10616 "audit"
10617 ]
10618 },
10619 "proxyto" : "master",
10620 "returns" : {
10621 "type" : "object"
10622 }
10623 },
10624 "PUT" : {
10625 "allowtoken" : 1,
10626 "description" : "Update spamquar configuration properties.",
10627 "method" : "PUT",
10628 "name" : "update_spamquar_section",
10629 "parameters" : {
10630 "additionalProperties" : 0,
10631 "properties" : {
10632 "allowhrefs" : {
10633 "default" : 1,
10634 "description" : "Allow to view hyperlinks.",
10635 "optional" : 1,
10636 "type" : "boolean",
10637 "typetext" : "<boolean>"
10638 },
10639 "authmode" : {
10640 "default" : "ticket",
10641 "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.",
10642 "enum" : [
10643 "ticket",
10644 "ldap",
10645 "ldapticket"
10646 ],
10647 "optional" : 1,
10648 "type" : "string"
10649 },
10650 "delete" : {
10651 "description" : "A list of settings you want to delete.",
10652 "format" : "pve-configid-list",
10653 "maxLength" : 4096,
10654 "optional" : 1,
10655 "type" : "string",
10656 "typetext" : "<string>"
10657 },
10658 "digest" : {
10659 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
10660 "maxLength" : 40,
10661 "optional" : 1,
10662 "type" : "string",
10663 "typetext" : "<string>"
10664 },
10665 "hostname" : {
10666 "description" : "Quarantine Host. Useful if you run a Cluster and want users to connect to a specific host.",
10667 "format" : "address",
10668 "optional" : 1,
10669 "type" : "string",
10670 "typetext" : "<string>"
10671 },
10672 "lifetime" : {
10673 "default" : 7,
10674 "description" : "Quarantine life time (days)",
10675 "minimum" : 1,
10676 "optional" : 1,
10677 "type" : "integer",
10678 "typetext" : "<integer> (1 - N)"
10679 },
10680 "mailfrom" : {
10681 "description" : "Text for 'From' header in daily spam report mails.",
10682 "optional" : 1,
10683 "type" : "string",
10684 "typetext" : "<string>"
10685 },
10686 "port" : {
10687 "default" : 8006,
10688 "description" : "Quarantine Port. Useful if you have a reverse proxy or port forwarding for the webinterface. Only used for the generated Spam report.",
10689 "maximum" : 65535,
10690 "minimum" : 1,
10691 "optional" : 1,
10692 "type" : "integer",
10693 "typetext" : "<integer> (1 - 65535)"
10694 },
10695 "protocol" : {
10696 "default" : "https",
10697 "description" : "Quarantine Webinterface Protocol. Useful if you have a reverse proxy for the webinterface. Only used for the generated Spam report.",
10698 "enum" : [
10699 "http",
10700 "https"
10701 ],
10702 "optional" : 1,
10703 "type" : "string"
10704 },
10705 "quarantinelink" : {
10706 "default" : 0,
10707 "description" : "Enables user self-service for Quarantine Links. Caution: this is accessible without authentication",
10708 "optional" : 1,
10709 "type" : "boolean",
10710 "typetext" : "<boolean>"
10711 },
10712 "reportstyle" : {
10713 "default" : "verbose",
10714 "description" : "Spam report style.",
10715 "enum" : [
10716 "none",
10717 "short",
10718 "verbose",
10719 "custom"
10720 ],
10721 "optional" : 1,
10722 "type" : "string"
10723 },
10724 "viewimages" : {
10725 "default" : 1,
10726 "description" : "Allow to view images.",
10727 "optional" : 1,
10728 "type" : "boolean",
10729 "typetext" : "<boolean>"
10730 }
10731 },
10732 "type" : "object"
10733 },
10734 "permissions" : {
10735 "check" : [
10736 "admin"
10737 ]
10738 },
10739 "protected" : 1,
10740 "proxyto" : "master",
10741 "returns" : {
10742 "type" : "null"
10743 }
10744 }
10745 },
10746 "leaf" : 1,
10747 "path" : "/config/spamquar",
10748 "text" : "spamquar"
10749 },
10750 {
10751 "info" : {
10752 "GET" : {
10753 "allowtoken" : 1,
10754 "description" : "Read virusquar configuration properties.",
10755 "method" : "GET",
10756 "name" : "read_virusquar_section",
10757 "parameters" : {
10758 "additionalProperties" : 0
10759 },
10760 "permissions" : {
10761 "check" : [
10762 "admin",
10763 "audit"
10764 ]
10765 },
10766 "proxyto" : "master",
10767 "returns" : {
10768 "type" : "object"
10769 }
10770 },
10771 "PUT" : {
10772 "allowtoken" : 1,
10773 "description" : "Update virusquar configuration properties.",
10774 "method" : "PUT",
10775 "name" : "update_virusquar_section",
10776 "parameters" : {
10777 "additionalProperties" : 0,
10778 "properties" : {
10779 "allowhrefs" : {
10780 "default" : 1,
10781 "description" : "Allow to view hyperlinks.",
10782 "optional" : 1,
10783 "type" : "boolean",
10784 "typetext" : "<boolean>"
10785 },
10786 "delete" : {
10787 "description" : "A list of settings you want to delete.",
10788 "format" : "pve-configid-list",
10789 "maxLength" : 4096,
10790 "optional" : 1,
10791 "type" : "string",
10792 "typetext" : "<string>"
10793 },
10794 "digest" : {
10795 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
10796 "maxLength" : 40,
10797 "optional" : 1,
10798 "type" : "string",
10799 "typetext" : "<string>"
10800 },
10801 "lifetime" : {
10802 "default" : 7,
10803 "description" : "Quarantine life time (days)",
10804 "minimum" : 1,
10805 "optional" : 1,
10806 "type" : "integer",
10807 "typetext" : "<integer> (1 - N)"
10808 },
10809 "viewimages" : {
10810 "default" : 1,
10811 "description" : "Allow to view images.",
10812 "optional" : 1,
10813 "type" : "boolean",
10814 "typetext" : "<boolean>"
10815 }
10816 },
10817 "type" : "object"
10818 },
10819 "permissions" : {
10820 "check" : [
10821 "admin"
10822 ]
10823 },
10824 "protected" : 1,
10825 "proxyto" : "master",
10826 "returns" : {
10827 "type" : "null"
10828 }
10829 }
10830 },
10831 "leaf" : 1,
10832 "path" : "/config/virusquar",
10833 "text" : "virusquar"
10834 },
10835 {
10836 "info" : {
10837 "POST" : {
10838 "allowtoken" : 1,
10839 "description" : "Test Regex ignoring case",
10840 "method" : "POST",
10841 "name" : "regextest",
10842 "parameters" : {
10843 "additionalProperties" : 0,
10844 "properties" : {
10845 "regex" : {
10846 "description" : "The Regex to test",
10847 "maxLength" : 1024,
10848 "type" : "string",
10849 "typetext" : "<string>"
10850 },
10851 "text" : {
10852 "description" : "The String to test",
10853 "maxLength" : 1024,
10854 "type" : "string",
10855 "typetext" : "<string>"
10856 }
10857 }
10858 },
10859 "permissions" : {
10860 "check" : [
10861 "admin",
10862 "qmanager",
10863 "audit"
10864 ]
10865 },
10866 "protected" : 0,
10867 "returns" : {
10868 "type" : "number"
10869 }
10870 }
10871 },
10872 "leaf" : 1,
10873 "path" : "/config/regextest",
10874 "text" : "regextest"
10875 }
10876 ],
10877 "info" : {
10878 "GET" : {
10879 "allowtoken" : 1,
10880 "description" : "Directory index.",
10881 "method" : "GET",
10882 "name" : "index",
10883 "parameters" : {
10884 "additionalProperties" : 0
10885 },
10886 "returns" : {
10887 "items" : {
10888 "properties" : {
10889 "section" : {
10890 "type" : "string"
10891 }
10892 },
10893 "type" : "object"
10894 },
10895 "links" : [
10896 {
10897 "href" : "{section}",
10898 "rel" : "child"
10899 }
10900 ],
10901 "type" : "array"
10902 }
10903 }
10904 },
10905 "leaf" : 0,
10906 "path" : "/config",
10907 "text" : "config"
10908 },
10909 {
10910 "children" : [
10911 {
10912 "children" : [
10913 {
10914 "children" : [
10915 {
10916 "info" : {
10917 "GET" : {
10918 "allowtoken" : 1,
10919 "description" : "Print Postfix queue domain and age distribution.",
10920 "method" : "GET",
10921 "name" : "qshape",
10922 "parameters" : {
10923 "additionalProperties" : 0,
10924 "properties" : {
10925 "node" : {
10926 "description" : "The cluster node name.",
10927 "format" : "pve-node",
10928 "type" : "string",
10929 "typetext" : "<string>"
10930 },
10931 "queue" : {
10932 "default" : "deferred",
10933 "description" : "Postfix queue name.",
10934 "enum" : [
10935 "deferred",
10936 "active",
10937 "incoming",
10938 "hold"
10939 ],
10940 "optional" : 1,
10941 "type" : "string"
10942 }
10943 }
10944 },
10945 "permissions" : {
10946 "check" : [
10947 "admin",
10948 "audit"
10949 ]
10950 },
10951 "protected" : 1,
10952 "proxyto" : "node",
10953 "returns" : {
10954 "items" : {
10955 "properties" : {},
10956 "type" : "object"
10957 },
10958 "type" : "array"
10959 }
10960 }
10961 },
10962 "leaf" : 1,
10963 "path" : "/nodes/{node}/postfix/qshape",
10964 "text" : "qshape"
10965 },
10966 {
10967 "children" : [
10968 {
10969 "children" : [
10970 {
10971 "info" : {
10972 "DELETE" : {
10973 "allowtoken" : 1,
10974 "description" : "Delete one message with the named queue ID.",
10975 "method" : "DELETE",
10976 "name" : "delete_queued_mail",
10977 "parameters" : {
10978 "additionalProperties" : 0,
10979 "properties" : {
10980 "node" : {
10981 "description" : "The cluster node name.",
10982 "format" : "pve-node",
10983 "type" : "string",
10984 "typetext" : "<string>"
10985 },
10986 "queue" : {
10987 "description" : "Postfix queue name.",
10988 "enum" : [
10989 "deferred",
10990 "active",
10991 "incoming",
10992 "hold"
10993 ],
10994 "type" : "string"
10995 },
10996 "queue_id" : {
10997 "description" : "The Message queue ID.",
10998 "maxLength" : 20,
10999 "minLength" : 8,
11000 "pattern" : "[a-zA-Z0-9]+",
11001 "type" : "string"
11002 }
11003 }
11004 },
11005 "permissions" : {
11006 "check" : [
11007 "admin"
11008 ]
11009 },
11010 "protected" : 1,
11011 "proxyto" : "node",
11012 "returns" : {
11013 "type" : "null"
11014 }
11015 },
11016 "GET" : {
11017 "allowtoken" : 1,
11018 "description" : "Get the contents of a queued mail.",
11019 "method" : "GET",
11020 "name" : "read_queued_mail",
11021 "parameters" : {
11022 "additionalProperties" : 0,
11023 "properties" : {
11024 "body" : {
11025 "default" : 0,
11026 "description" : "Include body content.",
11027 "optional" : 1,
11028 "type" : "boolean",
11029 "typetext" : "<boolean>"
11030 },
11031 "header" : {
11032 "default" : 1,
11033 "description" : "Show message header content.",
11034 "optional" : 1,
11035 "type" : "boolean",
11036 "typetext" : "<boolean>"
11037 },
11038 "node" : {
11039 "description" : "The cluster node name.",
11040 "format" : "pve-node",
11041 "type" : "string",
11042 "typetext" : "<string>"
11043 },
11044 "queue" : {
11045 "description" : "Postfix queue name.",
11046 "enum" : [
11047 "deferred",
11048 "active",
11049 "incoming",
11050 "hold"
11051 ],
11052 "type" : "string"
11053 },
11054 "queue_id" : {
11055 "description" : "The Message queue ID.",
11056 "maxLength" : 20,
11057 "minLength" : 8,
11058 "pattern" : "[a-zA-Z0-9]+",
11059 "type" : "string"
11060 }
11061 }
11062 },
11063 "permissions" : {
11064 "check" : [
11065 "admin"
11066 ]
11067 },
11068 "protected" : 1,
11069 "proxyto" : "node",
11070 "returns" : {
11071 "type" : "string"
11072 }
11073 },
11074 "POST" : {
11075 "allowtoken" : 1,
11076 "description" : "Schedule immediate delivery of deferred mail with the specified queue ID.",
11077 "method" : "POST",
11078 "name" : "flush_queued_mail",
11079 "parameters" : {
11080 "additionalProperties" : 0,
11081 "properties" : {
11082 "node" : {
11083 "description" : "The cluster node name.",
11084 "format" : "pve-node",
11085 "type" : "string",
11086 "typetext" : "<string>"
11087 },
11088 "queue" : {
11089 "description" : "Postfix queue name.",
11090 "enum" : [
11091 "deferred",
11092 "active",
11093 "incoming",
11094 "hold"
11095 ],
11096 "type" : "string"
11097 },
11098 "queue_id" : {
11099 "description" : "The Message queue ID.",
11100 "maxLength" : 20,
11101 "minLength" : 8,
11102 "pattern" : "[a-zA-Z0-9]+",
11103 "type" : "string"
11104 }
11105 }
11106 },
11107 "permissions" : {
11108 "check" : [
11109 "admin"
11110 ]
11111 },
11112 "protected" : 1,
11113 "proxyto" : "node",
11114 "returns" : {
11115 "type" : "null"
11116 }
11117 }
11118 },
11119 "leaf" : 1,
11120 "path" : "/nodes/{node}/postfix/queue/{queue}/{queue_id}",
11121 "text" : "{queue_id}"
11122 }
11123 ],
11124 "info" : {
11125 "DELETE" : {
11126 "allowtoken" : 1,
11127 "description" : "Delete all mails in the queue.",
11128 "method" : "DELETE",
11129 "name" : "delete_queue",
11130 "parameters" : {
11131 "additionalProperties" : 0,
11132 "properties" : {
11133 "node" : {
11134 "description" : "The cluster node name.",
11135 "format" : "pve-node",
11136 "type" : "string",
11137 "typetext" : "<string>"
11138 },
11139 "queue" : {
11140 "description" : "Postfix queue name.",
11141 "enum" : [
11142 "deferred",
11143 "active",
11144 "incoming",
11145 "hold"
11146 ],
11147 "type" : "string"
11148 }
11149 }
11150 },
11151 "permissions" : {
11152 "check" : [
11153 "admin"
11154 ]
11155 },
11156 "protected" : 1,
11157 "proxyto" : "node",
11158 "returns" : {
11159 "type" : "null"
11160 }
11161 },
11162 "GET" : {
11163 "allowtoken" : 1,
11164 "description" : "List the mail queue for a specific domain.",
11165 "method" : "GET",
11166 "name" : "mailq",
11167 "parameters" : {
11168 "additionalProperties" : 0,
11169 "properties" : {
11170 "filter" : {
11171 "description" : "Filter string.",
11172 "maxLength" : 64,
11173 "optional" : 1,
11174 "type" : "string",
11175 "typetext" : "<string>"
11176 },
11177 "limit" : {
11178 "minimum" : 0,
11179 "optional" : 1,
11180 "type" : "integer",
11181 "typetext" : "<integer> (0 - N)"
11182 },
11183 "node" : {
11184 "description" : "The cluster node name.",
11185 "format" : "pve-node",
11186 "type" : "string",
11187 "typetext" : "<string>"
11188 },
11189 "queue" : {
11190 "description" : "Postfix queue name.",
11191 "enum" : [
11192 "deferred",
11193 "active",
11194 "incoming",
11195 "hold"
11196 ],
11197 "type" : "string"
11198 },
11199 "sortdir" : {
11200 "description" : "Sort direction.",
11201 "enum" : [
11202 "ASC",
11203 "DESC"
11204 ],
11205 "optional" : 1,
11206 "requires" : "sortfield",
11207 "type" : "string"
11208 },
11209 "sortfield" : {
11210 "description" : "Sort field.",
11211 "enum" : [
11212 "arrival_time",
11213 "message_size",
11214 "sender",
11215 "receiver",
11216 "reason"
11217 ],
11218 "optional" : 1,
11219 "type" : "string"
11220 },
11221 "start" : {
11222 "minimum" : 0,
11223 "optional" : 1,
11224 "type" : "integer",
11225 "typetext" : "<integer> (0 - N)"
11226 }
11227 }
11228 },
11229 "permissions" : {
11230 "check" : [
11231 "admin",
11232 "audit"
11233 ]
11234 },
11235 "protected" : 1,
11236 "proxyto" : "node",
11237 "returns" : {
11238 "items" : {
11239 "properties" : {},
11240 "type" : "object"
11241 },
11242 "links" : [
11243 {
11244 "href" : "{queue_id}",
11245 "rel" : "child"
11246 }
11247 ],
11248 "type" : "array"
11249 }
11250 }
11251 },
11252 "leaf" : 0,
11253 "path" : "/nodes/{node}/postfix/queue/{queue}",
11254 "text" : "{queue}"
11255 }
11256 ],
11257 "info" : {
11258 "DELETE" : {
11259 "allowtoken" : 1,
11260 "description" : "Delete all mails in all posfix queues.",
11261 "method" : "DELETE",
11262 "name" : "delete_all_queues",
11263 "parameters" : {
11264 "additionalProperties" : 0,
11265 "properties" : {
11266 "node" : {
11267 "description" : "The cluster node name.",
11268 "format" : "pve-node",
11269 "type" : "string",
11270 "typetext" : "<string>"
11271 }
11272 }
11273 },
11274 "permissions" : {
11275 "check" : [
11276 "admin"
11277 ]
11278 },
11279 "protected" : 1,
11280 "proxyto" : "node",
11281 "returns" : {
11282 "type" : "null"
11283 }
11284 },
11285 "GET" : {
11286 "allowtoken" : 1,
11287 "description" : "Directory index.",
11288 "method" : "GET",
11289 "name" : "queue_index",
11290 "parameters" : {
11291 "additionalProperties" : 0,
11292 "properties" : {
11293 "node" : {
11294 "description" : "The cluster node name.",
11295 "format" : "pve-node",
11296 "type" : "string",
11297 "typetext" : "<string>"
11298 }
11299 }
11300 },
11301 "permissions" : {
11302 "user" : "all"
11303 },
11304 "returns" : {
11305 "items" : {
11306 "properties" : {},
11307 "type" : "object"
11308 },
11309 "links" : [
11310 {
11311 "href" : "{name}",
11312 "rel" : "child"
11313 }
11314 ],
11315 "type" : "array"
11316 }
11317 }
11318 },
11319 "leaf" : 0,
11320 "path" : "/nodes/{node}/postfix/queue",
11321 "text" : "queue"
11322 },
11323 {
11324 "info" : {
11325 "POST" : {
11326 "allowtoken" : 1,
11327 "description" : "Flush the queue: attempt to deliver all queued mail.",
11328 "method" : "POST",
11329 "name" : "flush_queues",
11330 "parameters" : {
11331 "additionalProperties" : 0,
11332 "properties" : {
11333 "node" : {
11334 "description" : "The cluster node name.",
11335 "format" : "pve-node",
11336 "type" : "string",
11337 "typetext" : "<string>"
11338 }
11339 }
11340 },
11341 "permissions" : {
11342 "check" : [
11343 "admin"
11344 ]
11345 },
11346 "protected" : 1,
11347 "proxyto" : "node",
11348 "returns" : {
11349 "type" : "null"
11350 }
11351 }
11352 },
11353 "leaf" : 1,
11354 "path" : "/nodes/{node}/postfix/flush_queues",
11355 "text" : "flush_queues"
11356 },
11357 {
11358 "info" : {
11359 "POST" : {
11360 "allowtoken" : 1,
11361 "description" : "Discards the address verification cache.",
11362 "method" : "POST",
11363 "name" : "discard_verify_cache",
11364 "parameters" : {
11365 "additionalProperties" : 0,
11366 "properties" : {
11367 "node" : {
11368 "description" : "The cluster node name.",
11369 "format" : "pve-node",
11370 "type" : "string",
11371 "typetext" : "<string>"
11372 }
11373 }
11374 },
11375 "permissions" : {
11376 "check" : [
11377 "admin"
11378 ]
11379 },
11380 "protected" : 1,
11381 "proxyto" : "node",
11382 "returns" : {
11383 "type" : "null"
11384 }
11385 }
11386 },
11387 "leaf" : 1,
11388 "path" : "/nodes/{node}/postfix/discard_verify_cache",
11389 "text" : "discard_verify_cache"
11390 }
11391 ],
11392 "info" : {
11393 "GET" : {
11394 "allowtoken" : 1,
11395 "description" : "Directory index.",
11396 "method" : "GET",
11397 "name" : "index",
11398 "parameters" : {
11399 "additionalProperties" : 0,
11400 "properties" : {
11401 "node" : {
11402 "description" : "The cluster node name.",
11403 "format" : "pve-node",
11404 "type" : "string",
11405 "typetext" : "<string>"
11406 }
11407 }
11408 },
11409 "permissions" : {
11410 "user" : "all"
11411 },
11412 "returns" : {
11413 "items" : {
11414 "properties" : {},
11415 "type" : "object"
11416 },
11417 "links" : [
11418 {
11419 "href" : "{name}",
11420 "rel" : "child"
11421 }
11422 ],
11423 "type" : "array"
11424 }
11425 }
11426 },
11427 "leaf" : 0,
11428 "path" : "/nodes/{node}/postfix",
11429 "text" : "postfix"
11430 },
11431 {
11432 "children" : [
11433 {
11434 "info" : {
11435 "GET" : {
11436 "allowtoken" : 1,
11437 "description" : "ClamAV virus database status.",
11438 "method" : "GET",
11439 "name" : "database_status",
11440 "parameters" : {
11441 "additionalProperties" : 0,
11442 "properties" : {
11443 "node" : {
11444 "description" : "The cluster node name.",
11445 "format" : "pve-node",
11446 "type" : "string",
11447 "typetext" : "<string>"
11448 }
11449 }
11450 },
11451 "permissions" : {
11452 "check" : [
11453 "admin",
11454 "audit"
11455 ]
11456 },
11457 "proxyto" : "node",
11458 "returns" : {
11459 "items" : {
11460 "properties" : {
11461 "build_time" : {
11462 "type" : "string"
11463 },
11464 "nsigs" : {
11465 "type" : "integer"
11466 },
11467 "type" : {
11468 "type" : "string"
11469 },
11470 "version" : {
11471 "optional" : 1,
11472 "type" : "string"
11473 }
11474 },
11475 "type" : "object"
11476 },
11477 "type" : "array"
11478 }
11479 },
11480 "POST" : {
11481 "allowtoken" : 1,
11482 "description" : "Update ClamAV virus databases.",
11483 "method" : "POST",
11484 "name" : "update_database",
11485 "parameters" : {
11486 "additionalProperties" : 0,
11487 "properties" : {
11488 "node" : {
11489 "description" : "The cluster node name.",
11490 "format" : "pve-node",
11491 "type" : "string",
11492 "typetext" : "<string>"
11493 }
11494 }
11495 },
11496 "permissions" : {
11497 "check" : [
11498 "admin"
11499 ]
11500 },
11501 "protected" : 1,
11502 "proxyto" : "node",
11503 "returns" : {
11504 "type" : "string"
11505 }
11506 }
11507 },
11508 "leaf" : 1,
11509 "path" : "/nodes/{node}/clamav/database",
11510 "text" : "database"
11511 }
11512 ],
11513 "info" : {
11514 "GET" : {
11515 "allowtoken" : 1,
11516 "description" : "Directory index.",
11517 "method" : "GET",
11518 "name" : "index",
11519 "parameters" : {
11520 "additionalProperties" : 0,
11521 "properties" : {
11522 "node" : {
11523 "description" : "The cluster node name.",
11524 "format" : "pve-node",
11525 "type" : "string",
11526 "typetext" : "<string>"
11527 }
11528 }
11529 },
11530 "permissions" : {
11531 "check" : [
11532 "admin",
11533 "audit"
11534 ]
11535 },
11536 "returns" : {
11537 "items" : {
11538 "properties" : {},
11539 "type" : "object"
11540 },
11541 "links" : [
11542 {
11543 "href" : "{subdir}",
11544 "rel" : "child"
11545 }
11546 ],
11547 "type" : "array"
11548 }
11549 }
11550 },
11551 "leaf" : 0,
11552 "path" : "/nodes/{node}/clamav",
11553 "text" : "clamav"
11554 },
11555 {
11556 "children" : [
11557 {
11558 "info" : {
11559 "GET" : {
11560 "allowtoken" : 1,
11561 "description" : "SpamAssassin rules status.",
11562 "method" : "GET",
11563 "name" : "rules_status",
11564 "parameters" : {
11565 "additionalProperties" : 0,
11566 "properties" : {
11567 "node" : {
11568 "description" : "The cluster node name.",
11569 "format" : "pve-node",
11570 "type" : "string",
11571 "typetext" : "<string>"
11572 }
11573 }
11574 },
11575 "permissions" : {
11576 "check" : [
11577 "admin",
11578 "audit"
11579 ]
11580 },
11581 "proxyto" : "node",
11582 "returns" : {
11583 "items" : {
11584 "properties" : {
11585 "channel" : {
11586 "type" : "string"
11587 },
11588 "last_updated" : {
11589 "optional" : 1,
11590 "type" : "integer"
11591 },
11592 "update_avail" : {
11593 "type" : "boolean"
11594 },
11595 "update_version" : {
11596 "optional" : 1,
11597 "type" : "string"
11598 },
11599 "version" : {
11600 "optional" : 1,
11601 "type" : "string"
11602 }
11603 },
11604 "type" : "object"
11605 },
11606 "type" : "array"
11607 }
11608 },
11609 "POST" : {
11610 "allowtoken" : 1,
11611 "description" : "Update SpamAssassin rules.",
11612 "method" : "POST",
11613 "name" : "update_rules",
11614 "parameters" : {
11615 "additionalProperties" : 0,
11616 "properties" : {
11617 "node" : {
11618 "description" : "The cluster node name.",
11619 "format" : "pve-node",
11620 "type" : "string",
11621 "typetext" : "<string>"
11622 }
11623 }
11624 },
11625 "permissions" : {
11626 "check" : [
11627 "admin"
11628 ]
11629 },
11630 "protected" : 1,
11631 "proxyto" : "node",
11632 "returns" : {
11633 "type" : "string"
11634 }
11635 }
11636 },
11637 "leaf" : 1,
11638 "path" : "/nodes/{node}/spamassassin/rules",
11639 "text" : "rules"
11640 }
11641 ],
11642 "info" : {
11643 "GET" : {
11644 "allowtoken" : 1,
11645 "description" : "Directory index.",
11646 "method" : "GET",
11647 "name" : "index",
11648 "parameters" : {
11649 "additionalProperties" : 0,
11650 "properties" : {
11651 "node" : {
11652 "description" : "The cluster node name.",
11653 "format" : "pve-node",
11654 "type" : "string",
11655 "typetext" : "<string>"
11656 }
11657 }
11658 },
11659 "permissions" : {
11660 "check" : [
11661 "admin",
11662 "audit"
11663 ]
11664 },
11665 "returns" : {
11666 "items" : {
11667 "properties" : {},
11668 "type" : "object"
11669 },
11670 "links" : [
11671 {
11672 "href" : "{subdir}",
11673 "rel" : "child"
11674 }
11675 ],
11676 "type" : "array"
11677 }
11678 }
11679 },
11680 "leaf" : 0,
11681 "path" : "/nodes/{node}/spamassassin",
11682 "text" : "spamassassin"
11683 },
11684 {
11685 "children" : [
11686 {
11687 "info" : {
11688 "DELETE" : {
11689 "allowtoken" : 1,
11690 "description" : "Delete network device configuration",
11691 "method" : "DELETE",
11692 "name" : "delete_network",
11693 "parameters" : {
11694 "additionalProperties" : 0,
11695 "properties" : {
11696 "iface" : {
11697 "description" : "Network interface name.",
11698 "format" : "pve-iface",
11699 "maxLength" : 20,
11700 "minLength" : 2,
11701 "type" : "string",
11702 "typetext" : "<string>"
11703 },
11704 "node" : {
11705 "description" : "The cluster node name.",
11706 "format" : "pve-node",
11707 "type" : "string",
11708 "typetext" : "<string>"
11709 }
11710 }
11711 },
11712 "protected" : 1,
11713 "proxyto" : "node",
11714 "returns" : {
11715 "type" : "null"
11716 }
11717 },
11718 "GET" : {
11719 "allowtoken" : 1,
11720 "description" : "Read network device configuration",
11721 "method" : "GET",
11722 "name" : "network_config",
11723 "parameters" : {
11724 "additionalProperties" : 0,
11725 "properties" : {
11726 "iface" : {
11727 "description" : "Network interface name.",
11728 "format" : "pve-iface",
11729 "maxLength" : 20,
11730 "minLength" : 2,
11731 "type" : "string",
11732 "typetext" : "<string>"
11733 },
11734 "node" : {
11735 "description" : "The cluster node name.",
11736 "format" : "pve-node",
11737 "type" : "string",
11738 "typetext" : "<string>"
11739 }
11740 }
11741 },
11742 "permissions" : {
11743 "check" : [
11744 "admin",
11745 "audit"
11746 ]
11747 },
11748 "proxyto" : "node",
11749 "returns" : {
11750 "properties" : {
11751 "method" : {
11752 "type" : "string"
11753 },
11754 "type" : {
11755 "type" : "string"
11756 }
11757 },
11758 "type" : "object"
11759 }
11760 },
11761 "PUT" : {
11762 "allowtoken" : 1,
11763 "description" : "Update network device configuration",
11764 "method" : "PUT",
11765 "name" : "update_network",
11766 "parameters" : {
11767 "additionalProperties" : 0,
11768 "properties" : {
11769 "address" : {
11770 "description" : "IP address.",
11771 "format" : "ipv4",
11772 "optional" : 1,
11773 "requires" : "netmask",
11774 "type" : "string",
11775 "typetext" : "<string>"
11776 },
11777 "address6" : {
11778 "description" : "IP address.",
11779 "format" : "ipv6",
11780 "optional" : 1,
11781 "requires" : "netmask6",
11782 "type" : "string",
11783 "typetext" : "<string>"
11784 },
11785 "autostart" : {
11786 "description" : "Automatically start interface on boot.",
11787 "optional" : 1,
11788 "type" : "boolean",
11789 "typetext" : "<boolean>"
11790 },
11791 "bond-primary" : {
11792 "description" : "Specify the primary interface for active-backup bond.",
11793 "format" : "pve-iface",
11794 "optional" : 1,
11795 "type" : "string",
11796 "typetext" : "<string>"
11797 },
11798 "bond_mode" : {
11799 "description" : "Bonding mode.",
11800 "enum" : [
11801 "balance-rr",
11802 "active-backup",
11803 "balance-xor",
11804 "broadcast",
11805 "802.3ad",
11806 "balance-tlb",
11807 "balance-alb",
11808 "balance-slb",
11809 "lacp-balance-slb",
11810 "lacp-balance-tcp"
11811 ],
11812 "optional" : 1,
11813 "type" : "string"
11814 },
11815 "bond_xmit_hash_policy" : {
11816 "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.",
11817 "enum" : [
11818 "layer2",
11819 "layer2+3",
11820 "layer3+4"
11821 ],
11822 "optional" : 1,
11823 "type" : "string"
11824 },
11825 "bridge_ports" : {
11826 "description" : "Specify the interfaces you want to add to your bridge.",
11827 "format" : "pve-iface-list",
11828 "optional" : 1,
11829 "type" : "string",
11830 "typetext" : "<string>"
11831 },
11832 "bridge_vlan_aware" : {
11833 "description" : "Enable bridge vlan support.",
11834 "optional" : 1,
11835 "type" : "boolean",
11836 "typetext" : "<boolean>"
11837 },
11838 "cidr" : {
11839 "description" : "IPv4 CIDR.",
11840 "format" : "CIDRv4",
11841 "optional" : 1,
11842 "type" : "string",
11843 "typetext" : "<string>"
11844 },
11845 "cidr6" : {
11846 "description" : "IPv6 CIDR.",
11847 "format" : "CIDRv6",
11848 "optional" : 1,
11849 "type" : "string",
11850 "typetext" : "<string>"
11851 },
11852 "comments" : {
11853 "description" : "Comments",
11854 "optional" : 1,
11855 "type" : "string",
11856 "typetext" : "<string>"
11857 },
11858 "comments6" : {
11859 "description" : "Comments",
11860 "optional" : 1,
11861 "type" : "string",
11862 "typetext" : "<string>"
11863 },
11864 "delete" : {
11865 "description" : "A list of settings you want to delete.",
11866 "format" : "pve-configid-list",
11867 "optional" : 1,
11868 "type" : "string",
11869 "typetext" : "<string>"
11870 },
11871 "gateway" : {
11872 "description" : "Default gateway address.",
11873 "format" : "ipv4",
11874 "optional" : 1,
11875 "type" : "string",
11876 "typetext" : "<string>"
11877 },
11878 "gateway6" : {
11879 "description" : "Default ipv6 gateway address.",
11880 "format" : "ipv6",
11881 "optional" : 1,
11882 "type" : "string",
11883 "typetext" : "<string>"
11884 },
11885 "iface" : {
11886 "description" : "Network interface name.",
11887 "format" : "pve-iface",
11888 "maxLength" : 20,
11889 "minLength" : 2,
11890 "type" : "string",
11891 "typetext" : "<string>"
11892 },
11893 "mtu" : {
11894 "description" : "MTU.",
11895 "maximum" : 65520,
11896 "minimum" : 1280,
11897 "optional" : 1,
11898 "type" : "integer",
11899 "typetext" : "<integer> (1280 - 65520)"
11900 },
11901 "netmask" : {
11902 "description" : "Network mask.",
11903 "format" : "ipv4mask",
11904 "optional" : 1,
11905 "requires" : "address",
11906 "type" : "string",
11907 "typetext" : "<string>"
11908 },
11909 "netmask6" : {
11910 "description" : "Network mask.",
11911 "maximum" : 128,
11912 "minimum" : 0,
11913 "optional" : 1,
11914 "requires" : "address6",
11915 "type" : "integer",
11916 "typetext" : "<integer> (0 - 128)"
11917 },
11918 "node" : {
11919 "description" : "The cluster node name.",
11920 "format" : "pve-node",
11921 "type" : "string",
11922 "typetext" : "<string>"
11923 },
11924 "ovs_bonds" : {
11925 "description" : "Specify the interfaces used by the bonding device.",
11926 "format" : "pve-iface-list",
11927 "optional" : 1,
11928 "type" : "string",
11929 "typetext" : "<string>"
11930 },
11931 "ovs_bridge" : {
11932 "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.",
11933 "format" : "pve-iface",
11934 "optional" : 1,
11935 "type" : "string",
11936 "typetext" : "<string>"
11937 },
11938 "ovs_options" : {
11939 "description" : "OVS interface options.",
11940 "maxLength" : 1024,
11941 "optional" : 1,
11942 "type" : "string",
11943 "typetext" : "<string>"
11944 },
11945 "ovs_ports" : {
11946 "description" : "Specify the interfaces you want to add to your bridge.",
11947 "format" : "pve-iface-list",
11948 "optional" : 1,
11949 "type" : "string",
11950 "typetext" : "<string>"
11951 },
11952 "ovs_tag" : {
11953 "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)",
11954 "maximum" : 4094,
11955 "minimum" : 1,
11956 "optional" : 1,
11957 "type" : "integer",
11958 "typetext" : "<integer> (1 - 4094)"
11959 },
11960 "slaves" : {
11961 "description" : "Specify the interfaces used by the bonding device.",
11962 "format" : "pve-iface-list",
11963 "optional" : 1,
11964 "type" : "string",
11965 "typetext" : "<string>"
11966 },
11967 "type" : {
11968 "description" : "Network interface type",
11969 "enum" : [
11970 "bridge",
11971 "bond",
11972 "eth",
11973 "alias",
11974 "vlan",
11975 "OVSBridge",
11976 "OVSBond",
11977 "OVSPort",
11978 "OVSIntPort",
11979 "unknown"
11980 ],
11981 "type" : "string"
11982 },
11983 "vlan-id" : {
11984 "description" : "vlan-id for a custom named vlan interface (ifupdown2 only).",
11985 "maximum" : 4094,
11986 "minimum" : 1,
11987 "optional" : 1,
11988 "type" : "integer",
11989 "typetext" : "<integer> (1 - 4094)"
11990 },
11991 "vlan-raw-device" : {
11992 "description" : "Specify the raw interface for the vlan interface.",
11993 "format" : "pve-iface",
11994 "optional" : 1,
11995 "type" : "string",
11996 "typetext" : "<string>"
11997 }
11998 }
11999 },
12000 "protected" : 1,
12001 "proxyto" : "node",
12002 "returns" : {
12003 "type" : "null"
12004 }
12005 }
12006 },
12007 "leaf" : 1,
12008 "path" : "/nodes/{node}/network/{iface}",
12009 "text" : "{iface}"
12010 }
12011 ],
12012 "info" : {
12013 "DELETE" : {
12014 "allowtoken" : 1,
12015 "description" : "Revert network configuration changes.",
12016 "method" : "DELETE",
12017 "name" : "revert_network_changes",
12018 "parameters" : {
12019 "additionalProperties" : 0,
12020 "properties" : {
12021 "node" : {
12022 "description" : "The cluster node name.",
12023 "format" : "pve-node",
12024 "type" : "string",
12025 "typetext" : "<string>"
12026 }
12027 }
12028 },
12029 "protected" : 1,
12030 "proxyto" : "node",
12031 "returns" : {
12032 "type" : "null"
12033 }
12034 },
12035 "GET" : {
12036 "allowtoken" : 1,
12037 "description" : "List available networks",
12038 "method" : "GET",
12039 "name" : "index",
12040 "parameters" : {
12041 "additionalProperties" : 0,
12042 "properties" : {
12043 "node" : {
12044 "description" : "The cluster node name.",
12045 "format" : "pve-node",
12046 "type" : "string",
12047 "typetext" : "<string>"
12048 },
12049 "type" : {
12050 "description" : "Only list specific interface types.",
12051 "enum" : [
12052 "bridge",
12053 "bond",
12054 "eth",
12055 "alias",
12056 "vlan",
12057 "OVSBridge",
12058 "OVSBond",
12059 "OVSPort",
12060 "OVSIntPort",
12061 "any_bridge"
12062 ],
12063 "optional" : 1,
12064 "type" : "string"
12065 }
12066 }
12067 },
12068 "permissions" : {
12069 "check" : [
12070 "admin",
12071 "audit"
12072 ]
12073 },
12074 "proxyto" : "node",
12075 "returns" : {
12076 "items" : {
12077 "properties" : {},
12078 "type" : "object"
12079 },
12080 "links" : [
12081 {
12082 "href" : "{iface}",
12083 "rel" : "child"
12084 }
12085 ],
12086 "type" : "array"
12087 }
12088 },
12089 "POST" : {
12090 "allowtoken" : 1,
12091 "description" : "Create network device configuration",
12092 "method" : "POST",
12093 "name" : "create_network",
12094 "parameters" : {
12095 "additionalProperties" : 0,
12096 "properties" : {
12097 "address" : {
12098 "description" : "IP address.",
12099 "format" : "ipv4",
12100 "optional" : 1,
12101 "requires" : "netmask",
12102 "type" : "string",
12103 "typetext" : "<string>"
12104 },
12105 "address6" : {
12106 "description" : "IP address.",
12107 "format" : "ipv6",
12108 "optional" : 1,
12109 "requires" : "netmask6",
12110 "type" : "string",
12111 "typetext" : "<string>"
12112 },
12113 "autostart" : {
12114 "description" : "Automatically start interface on boot.",
12115 "optional" : 1,
12116 "type" : "boolean",
12117 "typetext" : "<boolean>"
12118 },
12119 "bond-primary" : {
12120 "description" : "Specify the primary interface for active-backup bond.",
12121 "format" : "pve-iface",
12122 "optional" : 1,
12123 "type" : "string",
12124 "typetext" : "<string>"
12125 },
12126 "bond_mode" : {
12127 "description" : "Bonding mode.",
12128 "enum" : [
12129 "balance-rr",
12130 "active-backup",
12131 "balance-xor",
12132 "broadcast",
12133 "802.3ad",
12134 "balance-tlb",
12135 "balance-alb",
12136 "balance-slb",
12137 "lacp-balance-slb",
12138 "lacp-balance-tcp"
12139 ],
12140 "optional" : 1,
12141 "type" : "string"
12142 },
12143 "bond_xmit_hash_policy" : {
12144 "description" : "Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes.",
12145 "enum" : [
12146 "layer2",
12147 "layer2+3",
12148 "layer3+4"
12149 ],
12150 "optional" : 1,
12151 "type" : "string"
12152 },
12153 "bridge_ports" : {
12154 "description" : "Specify the interfaces you want to add to your bridge.",
12155 "format" : "pve-iface-list",
12156 "optional" : 1,
12157 "type" : "string",
12158 "typetext" : "<string>"
12159 },
12160 "bridge_vlan_aware" : {
12161 "description" : "Enable bridge vlan support.",
12162 "optional" : 1,
12163 "type" : "boolean",
12164 "typetext" : "<boolean>"
12165 },
12166 "cidr" : {
12167 "description" : "IPv4 CIDR.",
12168 "format" : "CIDRv4",
12169 "optional" : 1,
12170 "type" : "string",
12171 "typetext" : "<string>"
12172 },
12173 "cidr6" : {
12174 "description" : "IPv6 CIDR.",
12175 "format" : "CIDRv6",
12176 "optional" : 1,
12177 "type" : "string",
12178 "typetext" : "<string>"
12179 },
12180 "comments" : {
12181 "description" : "Comments",
12182 "optional" : 1,
12183 "type" : "string",
12184 "typetext" : "<string>"
12185 },
12186 "comments6" : {
12187 "description" : "Comments",
12188 "optional" : 1,
12189 "type" : "string",
12190 "typetext" : "<string>"
12191 },
12192 "gateway" : {
12193 "description" : "Default gateway address.",
12194 "format" : "ipv4",
12195 "optional" : 1,
12196 "type" : "string",
12197 "typetext" : "<string>"
12198 },
12199 "gateway6" : {
12200 "description" : "Default ipv6 gateway address.",
12201 "format" : "ipv6",
12202 "optional" : 1,
12203 "type" : "string",
12204 "typetext" : "<string>"
12205 },
12206 "iface" : {
12207 "description" : "Network interface name.",
12208 "format" : "pve-iface",
12209 "maxLength" : 20,
12210 "minLength" : 2,
12211 "type" : "string",
12212 "typetext" : "<string>"
12213 },
12214 "mtu" : {
12215 "description" : "MTU.",
12216 "maximum" : 65520,
12217 "minimum" : 1280,
12218 "optional" : 1,
12219 "type" : "integer",
12220 "typetext" : "<integer> (1280 - 65520)"
12221 },
12222 "netmask" : {
12223 "description" : "Network mask.",
12224 "format" : "ipv4mask",
12225 "optional" : 1,
12226 "requires" : "address",
12227 "type" : "string",
12228 "typetext" : "<string>"
12229 },
12230 "netmask6" : {
12231 "description" : "Network mask.",
12232 "maximum" : 128,
12233 "minimum" : 0,
12234 "optional" : 1,
12235 "requires" : "address6",
12236 "type" : "integer",
12237 "typetext" : "<integer> (0 - 128)"
12238 },
12239 "node" : {
12240 "description" : "The cluster node name.",
12241 "format" : "pve-node",
12242 "type" : "string",
12243 "typetext" : "<string>"
12244 },
12245 "ovs_bonds" : {
12246 "description" : "Specify the interfaces used by the bonding device.",
12247 "format" : "pve-iface-list",
12248 "optional" : 1,
12249 "type" : "string",
12250 "typetext" : "<string>"
12251 },
12252 "ovs_bridge" : {
12253 "description" : "The OVS bridge associated with a OVS port. This is required when you create an OVS port.",
12254 "format" : "pve-iface",
12255 "optional" : 1,
12256 "type" : "string",
12257 "typetext" : "<string>"
12258 },
12259 "ovs_options" : {
12260 "description" : "OVS interface options.",
12261 "maxLength" : 1024,
12262 "optional" : 1,
12263 "type" : "string",
12264 "typetext" : "<string>"
12265 },
12266 "ovs_ports" : {
12267 "description" : "Specify the interfaces you want to add to your bridge.",
12268 "format" : "pve-iface-list",
12269 "optional" : 1,
12270 "type" : "string",
12271 "typetext" : "<string>"
12272 },
12273 "ovs_tag" : {
12274 "description" : "Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)",
12275 "maximum" : 4094,
12276 "minimum" : 1,
12277 "optional" : 1,
12278 "type" : "integer",
12279 "typetext" : "<integer> (1 - 4094)"
12280 },
12281 "slaves" : {
12282 "description" : "Specify the interfaces used by the bonding device.",
12283 "format" : "pve-iface-list",
12284 "optional" : 1,
12285 "type" : "string",
12286 "typetext" : "<string>"
12287 },
12288 "type" : {
12289 "description" : "Network interface type",
12290 "enum" : [
12291 "bridge",
12292 "bond",
12293 "eth",
12294 "alias",
12295 "vlan",
12296 "OVSBridge",
12297 "OVSBond",
12298 "OVSPort",
12299 "OVSIntPort",
12300 "unknown"
12301 ],
12302 "type" : "string"
12303 },
12304 "vlan-id" : {
12305 "description" : "vlan-id for a custom named vlan interface (ifupdown2 only).",
12306 "maximum" : 4094,
12307 "minimum" : 1,
12308 "optional" : 1,
12309 "type" : "integer",
12310 "typetext" : "<integer> (1 - 4094)"
12311 },
12312 "vlan-raw-device" : {
12313 "description" : "Specify the raw interface for the vlan interface.",
12314 "format" : "pve-iface",
12315 "optional" : 1,
12316 "type" : "string",
12317 "typetext" : "<string>"
12318 }
12319 }
12320 },
12321 "protected" : 1,
12322 "proxyto" : "node",
12323 "returns" : {
12324 "type" : "null"
12325 }
12326 }
12327 },
12328 "leaf" : 0,
12329 "path" : "/nodes/{node}/network",
12330 "text" : "network"
12331 },
12332 {
12333 "children" : [
12334 {
12335 "children" : [
12336 {
12337 "info" : {
12338 "GET" : {
12339 "allowtoken" : 1,
12340 "description" : "Read task log.",
12341 "method" : "GET",
12342 "name" : "read_task_log",
12343 "parameters" : {
12344 "additionalProperties" : 0,
12345 "properties" : {
12346 "limit" : {
12347 "minimum" : 0,
12348 "optional" : 1,
12349 "type" : "integer",
12350 "typetext" : "<integer> (0 - N)"
12351 },
12352 "node" : {
12353 "description" : "The cluster node name.",
12354 "format" : "pve-node",
12355 "type" : "string",
12356 "typetext" : "<string>"
12357 },
12358 "start" : {
12359 "minimum" : 0,
12360 "optional" : 1,
12361 "type" : "integer",
12362 "typetext" : "<integer> (0 - N)"
12363 },
12364 "upid" : {
12365 "type" : "string",
12366 "typetext" : "<string>"
12367 }
12368 }
12369 },
12370 "permissions" : {
12371 "check" : [
12372 "admin",
12373 "audit"
12374 ]
12375 },
12376 "protected" : 1,
12377 "proxyto" : "node",
12378 "returns" : {
12379 "items" : {
12380 "properties" : {
12381 "n" : {
12382 "description" : "Line number",
12383 "type" : "integer"
12384 },
12385 "t" : {
12386 "description" : "Line text",
12387 "type" : "string"
12388 }
12389 },
12390 "type" : "object"
12391 },
12392 "type" : "array"
12393 }
12394 }
12395 },
12396 "leaf" : 1,
12397 "path" : "/nodes/{node}/tasks/{upid}/log",
12398 "text" : "log"
12399 },
12400 {
12401 "info" : {
12402 "GET" : {
12403 "allowtoken" : 1,
12404 "description" : "Read task status.",
12405 "method" : "GET",
12406 "name" : "read_task_status",
12407 "parameters" : {
12408 "additionalProperties" : 0,
12409 "properties" : {
12410 "node" : {
12411 "description" : "The cluster node name.",
12412 "format" : "pve-node",
12413 "type" : "string",
12414 "typetext" : "<string>"
12415 },
12416 "upid" : {
12417 "type" : "string",
12418 "typetext" : "<string>"
12419 }
12420 }
12421 },
12422 "permissions" : {
12423 "check" : [
12424 "admin",
12425 "audit"
12426 ]
12427 },
12428 "protected" : 1,
12429 "proxyto" : "node",
12430 "returns" : {
12431 "properties" : {
12432 "pid" : {
12433 "type" : "integer"
12434 },
12435 "status" : {
12436 "enum" : [
12437 "running",
12438 "stopped"
12439 ],
12440 "type" : "string"
12441 }
12442 },
12443 "type" : "object"
12444 }
12445 }
12446 },
12447 "leaf" : 1,
12448 "path" : "/nodes/{node}/tasks/{upid}/status",
12449 "text" : "status"
12450 }
12451 ],
12452 "info" : {
12453 "DELETE" : {
12454 "allowtoken" : 1,
12455 "description" : "Stop a task.",
12456 "method" : "DELETE",
12457 "name" : "stop_task",
12458 "parameters" : {
12459 "additionalProperties" : 0,
12460 "properties" : {
12461 "node" : {
12462 "description" : "The cluster node name.",
12463 "format" : "pve-node",
12464 "type" : "string",
12465 "typetext" : "<string>"
12466 },
12467 "upid" : {
12468 "type" : "string",
12469 "typetext" : "<string>"
12470 }
12471 }
12472 },
12473 "permissions" : {
12474 "check" : [
12475 "admin"
12476 ]
12477 },
12478 "protected" : 1,
12479 "proxyto" : "node",
12480 "returns" : {
12481 "type" : "null"
12482 }
12483 },
12484 "GET" : {
12485 "allowtoken" : 1,
12486 "description" : "",
12487 "method" : "GET",
12488 "name" : "upid_index",
12489 "parameters" : {
12490 "additionalProperties" : 0,
12491 "properties" : {
12492 "node" : {
12493 "description" : "The cluster node name.",
12494 "format" : "pve-node",
12495 "type" : "string",
12496 "typetext" : "<string>"
12497 },
12498 "upid" : {
12499 "type" : "string",
12500 "typetext" : "<string>"
12501 }
12502 }
12503 },
12504 "permissions" : {
12505 "check" : [
12506 "admin",
12507 "audit"
12508 ]
12509 },
12510 "returns" : {
12511 "items" : {
12512 "properties" : {},
12513 "type" : "object"
12514 },
12515 "links" : [
12516 {
12517 "href" : "{name}",
12518 "rel" : "child"
12519 }
12520 ],
12521 "type" : "array"
12522 }
12523 }
12524 },
12525 "leaf" : 0,
12526 "path" : "/nodes/{node}/tasks/{upid}",
12527 "text" : "{upid}"
12528 }
12529 ],
12530 "info" : {
12531 "GET" : {
12532 "allowtoken" : 1,
12533 "description" : "Read task list for one node (finished tasks).",
12534 "method" : "GET",
12535 "name" : "node_tasks",
12536 "parameters" : {
12537 "additionalProperties" : 0,
12538 "properties" : {
12539 "errors" : {
12540 "optional" : 1,
12541 "type" : "boolean",
12542 "typetext" : "<boolean>"
12543 },
12544 "limit" : {
12545 "minimum" : 0,
12546 "optional" : 1,
12547 "type" : "integer",
12548 "typetext" : "<integer> (0 - N)"
12549 },
12550 "node" : {
12551 "description" : "The cluster node name.",
12552 "format" : "pve-node",
12553 "type" : "string",
12554 "typetext" : "<string>"
12555 },
12556 "since" : {
12557 "description" : "Only list tasks since this UNIX epoch.",
12558 "optional" : 1,
12559 "type" : "integer",
12560 "typetext" : "<integer>"
12561 },
12562 "start" : {
12563 "minimum" : 0,
12564 "optional" : 1,
12565 "type" : "integer",
12566 "typetext" : "<integer> (0 - N)"
12567 },
12568 "statusfilter" : {
12569 "description" : "List of Task States that should be returned.",
12570 "format" : "pve-task-status-type-list",
12571 "optional" : 1,
12572 "type" : "string",
12573 "typetext" : "<string>"
12574 },
12575 "typefilter" : {
12576 "description" : "Only list tasks of this type (e.g., aptupdate, saupdate).",
12577 "optional" : 1,
12578 "type" : "string",
12579 "typetext" : "<string>"
12580 },
12581 "until" : {
12582 "description" : "Only list tasks until this UNIX epoch.",
12583 "optional" : 1,
12584 "type" : "integer",
12585 "typetext" : "<integer>"
12586 },
12587 "userfilter" : {
12588 "optional" : 1,
12589 "type" : "string",
12590 "typetext" : "<string>"
12591 }
12592 }
12593 },
12594 "permissions" : {
12595 "check" : [
12596 "admin",
12597 "audit"
12598 ]
12599 },
12600 "proxyto" : "node",
12601 "returns" : {
12602 "items" : {
12603 "properties" : {
12604 "upid" : {
12605 "type" : "string"
12606 }
12607 },
12608 "type" : "object"
12609 },
12610 "links" : [
12611 {
12612 "href" : "{upid}",
12613 "rel" : "child"
12614 }
12615 ],
12616 "type" : "array"
12617 }
12618 }
12619 },
12620 "leaf" : 0,
12621 "path" : "/nodes/{node}/tasks",
12622 "text" : "tasks"
12623 },
12624 {
12625 "children" : [
12626 {
12627 "children" : [
12628 {
12629 "info" : {
12630 "GET" : {
12631 "allowtoken" : 1,
12632 "description" : "Read service properties",
12633 "method" : "GET",
12634 "name" : "service_state",
12635 "parameters" : {
12636 "additionalProperties" : 0,
12637 "properties" : {
12638 "node" : {
12639 "description" : "The cluster node name.",
12640 "format" : "pve-node",
12641 "type" : "string",
12642 "typetext" : "<string>"
12643 },
12644 "service" : {
12645 "description" : "Service ID",
12646 "enum" : [
12647 "clamav-daemon",
12648 "clamav-freshclam",
12649 "fetchmail",
12650 "pmgproxy",
12651 "pmgdaemon",
12652 "pmgpolicy",
12653 "pmg-smtp-filter",
12654 "pmgtunnel",
12655 "pmgmirror",
12656 "ssh",
12657 "rsyslog",
12658 "postfix",
12659 "postgres",
12660 "systemd-timesyncd",
12661 "pmg-hourly",
12662 "pmg-daily",
12663 "pmgreport",
12664 "pmgspamreport"
12665 ],
12666 "type" : "string"
12667 }
12668 }
12669 },
12670 "permissions" : {
12671 "check" : [
12672 "admin",
12673 "audit"
12674 ]
12675 },
12676 "protected" : 1,
12677 "proxyto" : "node",
12678 "returns" : {
12679 "type" : "object"
12680 }
12681 }
12682 },
12683 "leaf" : 1,
12684 "path" : "/nodes/{node}/services/{service}/state",
12685 "text" : "state"
12686 },
12687 {
12688 "info" : {
12689 "POST" : {
12690 "allowtoken" : 1,
12691 "description" : "Start service.",
12692 "method" : "POST",
12693 "name" : "service_start",
12694 "parameters" : {
12695 "additionalProperties" : 0,
12696 "properties" : {
12697 "node" : {
12698 "description" : "The cluster node name.",
12699 "format" : "pve-node",
12700 "type" : "string",
12701 "typetext" : "<string>"
12702 },
12703 "service" : {
12704 "description" : "Service ID",
12705 "enum" : [
12706 "clamav-daemon",
12707 "clamav-freshclam",
12708 "fetchmail",
12709 "pmgproxy",
12710 "pmgdaemon",
12711 "pmgpolicy",
12712 "pmg-smtp-filter",
12713 "pmgtunnel",
12714 "pmgmirror",
12715 "ssh",
12716 "rsyslog",
12717 "postfix",
12718 "postgres",
12719 "systemd-timesyncd",
12720 "pmg-hourly",
12721 "pmg-daily",
12722 "pmgreport",
12723 "pmgspamreport"
12724 ],
12725 "type" : "string"
12726 }
12727 }
12728 },
12729 "permissions" : {
12730 "check" : [
12731 "admin"
12732 ]
12733 },
12734 "protected" : 1,
12735 "proxyto" : "node",
12736 "returns" : {
12737 "type" : "string"
12738 }
12739 }
12740 },
12741 "leaf" : 1,
12742 "path" : "/nodes/{node}/services/{service}/start",
12743 "text" : "start"
12744 },
12745 {
12746 "info" : {
12747 "POST" : {
12748 "allowtoken" : 1,
12749 "description" : "Stop service.",
12750 "method" : "POST",
12751 "name" : "service_stop",
12752 "parameters" : {
12753 "additionalProperties" : 0,
12754 "properties" : {
12755 "node" : {
12756 "description" : "The cluster node name.",
12757 "format" : "pve-node",
12758 "type" : "string",
12759 "typetext" : "<string>"
12760 },
12761 "service" : {
12762 "description" : "Service ID",
12763 "enum" : [
12764 "clamav-daemon",
12765 "clamav-freshclam",
12766 "fetchmail",
12767 "pmgproxy",
12768 "pmgdaemon",
12769 "pmgpolicy",
12770 "pmg-smtp-filter",
12771 "pmgtunnel",
12772 "pmgmirror",
12773 "ssh",
12774 "rsyslog",
12775 "postfix",
12776 "postgres",
12777 "systemd-timesyncd",
12778 "pmg-hourly",
12779 "pmg-daily",
12780 "pmgreport",
12781 "pmgspamreport"
12782 ],
12783 "type" : "string"
12784 }
12785 }
12786 },
12787 "permissions" : {
12788 "check" : [
12789 "admin"
12790 ]
12791 },
12792 "protected" : 1,
12793 "proxyto" : "node",
12794 "returns" : {
12795 "type" : "string"
12796 }
12797 }
12798 },
12799 "leaf" : 1,
12800 "path" : "/nodes/{node}/services/{service}/stop",
12801 "text" : "stop"
12802 },
12803 {
12804 "info" : {
12805 "POST" : {
12806 "allowtoken" : 1,
12807 "description" : "Restart service.",
12808 "method" : "POST",
12809 "name" : "service_restart",
12810 "parameters" : {
12811 "additionalProperties" : 0,
12812 "properties" : {
12813 "node" : {
12814 "description" : "The cluster node name.",
12815 "format" : "pve-node",
12816 "type" : "string",
12817 "typetext" : "<string>"
12818 },
12819 "service" : {
12820 "description" : "Service ID",
12821 "enum" : [
12822 "clamav-daemon",
12823 "clamav-freshclam",
12824 "fetchmail",
12825 "pmgproxy",
12826 "pmgdaemon",
12827 "pmgpolicy",
12828 "pmg-smtp-filter",
12829 "pmgtunnel",
12830 "pmgmirror",
12831 "ssh",
12832 "rsyslog",
12833 "postfix",
12834 "postgres",
12835 "systemd-timesyncd",
12836 "pmg-hourly",
12837 "pmg-daily",
12838 "pmgreport",
12839 "pmgspamreport"
12840 ],
12841 "type" : "string"
12842 }
12843 }
12844 },
12845 "permissions" : {
12846 "check" : [
12847 "admin"
12848 ]
12849 },
12850 "protected" : 1,
12851 "proxyto" : "node",
12852 "returns" : {
12853 "type" : "string"
12854 }
12855 }
12856 },
12857 "leaf" : 1,
12858 "path" : "/nodes/{node}/services/{service}/restart",
12859 "text" : "restart"
12860 },
12861 {
12862 "info" : {
12863 "POST" : {
12864 "allowtoken" : 1,
12865 "description" : "Reload service.",
12866 "method" : "POST",
12867 "name" : "service_reload",
12868 "parameters" : {
12869 "additionalProperties" : 0,
12870 "properties" : {
12871 "node" : {
12872 "description" : "The cluster node name.",
12873 "format" : "pve-node",
12874 "type" : "string",
12875 "typetext" : "<string>"
12876 },
12877 "service" : {
12878 "description" : "Service ID",
12879 "enum" : [
12880 "clamav-daemon",
12881 "clamav-freshclam",
12882 "fetchmail",
12883 "pmgproxy",
12884 "pmgdaemon",
12885 "pmgpolicy",
12886 "pmg-smtp-filter",
12887 "pmgtunnel",
12888 "pmgmirror",
12889 "ssh",
12890 "rsyslog",
12891 "postfix",
12892 "postgres",
12893 "systemd-timesyncd",
12894 "pmg-hourly",
12895 "pmg-daily",
12896 "pmgreport",
12897 "pmgspamreport"
12898 ],
12899 "type" : "string"
12900 }
12901 }
12902 },
12903 "permissions" : {
12904 "check" : [
12905 "admin"
12906 ]
12907 },
12908 "protected" : 1,
12909 "proxyto" : "node",
12910 "returns" : {
12911 "type" : "string"
12912 }
12913 }
12914 },
12915 "leaf" : 1,
12916 "path" : "/nodes/{node}/services/{service}/reload",
12917 "text" : "reload"
12918 }
12919 ],
12920 "info" : {
12921 "GET" : {
12922 "allowtoken" : 1,
12923 "description" : "Directory index",
12924 "method" : "GET",
12925 "name" : "srvcmdidx",
12926 "parameters" : {
12927 "additionalProperties" : 0,
12928 "properties" : {
12929 "node" : {
12930 "description" : "The cluster node name.",
12931 "format" : "pve-node",
12932 "type" : "string",
12933 "typetext" : "<string>"
12934 },
12935 "service" : {
12936 "description" : "Service ID",
12937 "enum" : [
12938 "clamav-daemon",
12939 "clamav-freshclam",
12940 "fetchmail",
12941 "pmgproxy",
12942 "pmgdaemon",
12943 "pmgpolicy",
12944 "pmg-smtp-filter",
12945 "pmgtunnel",
12946 "pmgmirror",
12947 "ssh",
12948 "rsyslog",
12949 "postfix",
12950 "postgres",
12951 "systemd-timesyncd",
12952 "pmg-hourly",
12953 "pmg-daily",
12954 "pmgreport",
12955 "pmgspamreport"
12956 ],
12957 "type" : "string"
12958 }
12959 }
12960 },
12961 "permissions" : {
12962 "check" : [
12963 "admin",
12964 "audit"
12965 ]
12966 },
12967 "returns" : {
12968 "items" : {
12969 "properties" : {
12970 "subdir" : {
12971 "type" : "string"
12972 }
12973 },
12974 "type" : "object"
12975 },
12976 "links" : [
12977 {
12978 "href" : "{subdir}",
12979 "rel" : "child"
12980 }
12981 ],
12982 "type" : "array"
12983 }
12984 }
12985 },
12986 "leaf" : 0,
12987 "path" : "/nodes/{node}/services/{service}",
12988 "text" : "{service}"
12989 }
12990 ],
12991 "info" : {
12992 "GET" : {
12993 "allowtoken" : 1,
12994 "description" : "Service list.",
12995 "method" : "GET",
12996 "name" : "index",
12997 "parameters" : {
12998 "additionalProperties" : 0,
12999 "properties" : {
13000 "node" : {
13001 "description" : "The cluster node name.",
13002 "format" : "pve-node",
13003 "type" : "string",
13004 "typetext" : "<string>"
13005 }
13006 }
13007 },
13008 "permissions" : {
13009 "check" : [
13010 "admin",
13011 "audit"
13012 ]
13013 },
13014 "protected" : 1,
13015 "proxyto" : "node",
13016 "returns" : {
13017 "items" : {
13018 "properties" : {},
13019 "type" : "object"
13020 },
13021 "links" : [
13022 {
13023 "href" : "{service}",
13024 "rel" : "child"
13025 }
13026 ],
13027 "type" : "array"
13028 }
13029 }
13030 },
13031 "leaf" : 0,
13032 "path" : "/nodes/{node}/services",
13033 "text" : "services"
13034 },
13035 {
13036 "info" : {
13037 "DELETE" : {
13038 "allowtoken" : 1,
13039 "description" : "Delete subscription key.",
13040 "method" : "DELETE",
13041 "name" : "delete",
13042 "parameters" : {
13043 "additionalProperties" : 0,
13044 "properties" : {
13045 "node" : {
13046 "description" : "The cluster node name.",
13047 "format" : "pve-node",
13048 "type" : "string",
13049 "typetext" : "<string>"
13050 }
13051 }
13052 },
13053 "protected" : 1,
13054 "proxyto" : "node",
13055 "returns" : {
13056 "type" : "null"
13057 }
13058 },
13059 "GET" : {
13060 "allowtoken" : 1,
13061 "description" : "Read subscription info.",
13062 "method" : "GET",
13063 "name" : "get",
13064 "parameters" : {
13065 "additionalProperties" : 0,
13066 "properties" : {
13067 "node" : {
13068 "description" : "The cluster node name.",
13069 "format" : "pve-node",
13070 "type" : "string",
13071 "typetext" : "<string>"
13072 }
13073 }
13074 },
13075 "permissions" : {
13076 "check" : [
13077 "admin",
13078 "qmanager",
13079 "audit",
13080 "quser"
13081 ]
13082 },
13083 "proxyto" : "node",
13084 "returns" : {
13085 "type" : "object"
13086 }
13087 },
13088 "POST" : {
13089 "allowtoken" : 1,
13090 "description" : "Update subscription info.",
13091 "method" : "POST",
13092 "name" : "update",
13093 "parameters" : {
13094 "additionalProperties" : 0,
13095 "properties" : {
13096 "force" : {
13097 "default" : 0,
13098 "description" : "Always connect to server, even if we have up to date info inside local cache.",
13099 "optional" : 1,
13100 "type" : "boolean",
13101 "typetext" : "<boolean>"
13102 },
13103 "node" : {
13104 "description" : "The cluster node name.",
13105 "format" : "pve-node",
13106 "type" : "string",
13107 "typetext" : "<string>"
13108 }
13109 }
13110 },
13111 "permissions" : {
13112 "check" : [
13113 "admin"
13114 ]
13115 },
13116 "protected" : 1,
13117 "proxyto" : "node",
13118 "returns" : {
13119 "type" : "null"
13120 }
13121 },
13122 "PUT" : {
13123 "allowtoken" : 1,
13124 "description" : "Set subscription key.",
13125 "method" : "PUT",
13126 "name" : "set",
13127 "parameters" : {
13128 "additionalProperties" : 0,
13129 "properties" : {
13130 "key" : {
13131 "description" : "Proxmox Mail Gateway subscription key",
13132 "maxLength" : 32,
13133 "pattern" : "pmg([cbsp])-[0-9a-f]{10}",
13134 "type" : "string"
13135 },
13136 "node" : {
13137 "description" : "The cluster node name.",
13138 "format" : "pve-node",
13139 "type" : "string",
13140 "typetext" : "<string>"
13141 }
13142 }
13143 },
13144 "protected" : 1,
13145 "proxyto" : "node",
13146 "returns" : {
13147 "type" : "null"
13148 }
13149 }
13150 },
13151 "leaf" : 1,
13152 "path" : "/nodes/{node}/subscription",
13153 "text" : "subscription"
13154 },
13155 {
13156 "children" : [
13157 {
13158 "info" : {
13159 "GET" : {
13160 "allowtoken" : 1,
13161 "description" : "List available updates.",
13162 "method" : "GET",
13163 "name" : "list_updates",
13164 "parameters" : {
13165 "additionalProperties" : 0,
13166 "properties" : {
13167 "node" : {
13168 "description" : "The cluster node name.",
13169 "format" : "pve-node",
13170 "type" : "string",
13171 "typetext" : "<string>"
13172 }
13173 }
13174 },
13175 "permissions" : {
13176 "check" : [
13177 "admin",
13178 "audit"
13179 ]
13180 },
13181 "protected" : 1,
13182 "proxyto" : "node",
13183 "returns" : {
13184 "items" : {
13185 "properties" : {},
13186 "type" : "object"
13187 },
13188 "type" : "array"
13189 }
13190 },
13191 "POST" : {
13192 "allowtoken" : 1,
13193 "description" : "This is used to resynchronize the package index files from their sources (apt-get update).",
13194 "method" : "POST",
13195 "name" : "update_database",
13196 "parameters" : {
13197 "additionalProperties" : 0,
13198 "properties" : {
13199 "node" : {
13200 "description" : "The cluster node name.",
13201 "format" : "pve-node",
13202 "type" : "string",
13203 "typetext" : "<string>"
13204 },
13205 "notify" : {
13206 "default" : 0,
13207 "description" : "Send notification mail about new packages (to email address specified for user 'root@pam').",
13208 "optional" : 1,
13209 "type" : "boolean",
13210 "typetext" : "<boolean>"
13211 },
13212 "quiet" : {
13213 "default" : 0,
13214 "description" : "Only produces output suitable for logging, omitting progress indicators.",
13215 "optional" : 1,
13216 "type" : "boolean",
13217 "typetext" : "<boolean>"
13218 }
13219 }
13220 },
13221 "permissions" : {
13222 "check" : [
13223 "admin"
13224 ]
13225 },
13226 "protected" : 1,
13227 "proxyto" : "node",
13228 "returns" : {
13229 "type" : "string"
13230 }
13231 }
13232 },
13233 "leaf" : 1,
13234 "path" : "/nodes/{node}/apt/update",
13235 "text" : "update"
13236 },
13237 {
13238 "info" : {
13239 "GET" : {
13240 "allowtoken" : 1,
13241 "description" : "Get package changelogs.",
13242 "method" : "GET",
13243 "name" : "changelog",
13244 "parameters" : {
13245 "additionalProperties" : 0,
13246 "properties" : {
13247 "name" : {
13248 "description" : "Package name.",
13249 "type" : "string",
13250 "typetext" : "<string>"
13251 },
13252 "node" : {
13253 "description" : "The cluster node name.",
13254 "format" : "pve-node",
13255 "type" : "string",
13256 "typetext" : "<string>"
13257 },
13258 "version" : {
13259 "description" : "Package version.",
13260 "optional" : 1,
13261 "type" : "string",
13262 "typetext" : "<string>"
13263 }
13264 }
13265 },
13266 "permissions" : {
13267 "check" : [
13268 "admin",
13269 "audit"
13270 ]
13271 },
13272 "proxyto" : "node",
13273 "returns" : {
13274 "type" : "string"
13275 }
13276 }
13277 },
13278 "leaf" : 1,
13279 "path" : "/nodes/{node}/apt/changelog",
13280 "text" : "changelog"
13281 },
13282 {
13283 "info" : {
13284 "GET" : {
13285 "allowtoken" : 1,
13286 "description" : "Get package information for important Proxmox packages.",
13287 "method" : "GET",
13288 "name" : "versions",
13289 "parameters" : {
13290 "additionalProperties" : 0,
13291 "properties" : {
13292 "node" : {
13293 "description" : "The cluster node name.",
13294 "format" : "pve-node",
13295 "type" : "string",
13296 "typetext" : "<string>"
13297 }
13298 }
13299 },
13300 "permissions" : {
13301 "check" : [
13302 "admin",
13303 "audit"
13304 ]
13305 },
13306 "proxyto" : "node",
13307 "returns" : {
13308 "items" : {
13309 "properties" : {},
13310 "type" : "object"
13311 },
13312 "type" : "array"
13313 }
13314 }
13315 },
13316 "leaf" : 1,
13317 "path" : "/nodes/{node}/apt/versions",
13318 "text" : "versions"
13319 }
13320 ],
13321 "info" : {
13322 "GET" : {
13323 "allowtoken" : 1,
13324 "description" : "Directory index for apt (Advanced Package Tool).",
13325 "method" : "GET",
13326 "name" : "index",
13327 "parameters" : {
13328 "additionalProperties" : 0,
13329 "properties" : {
13330 "node" : {
13331 "description" : "The cluster node name.",
13332 "format" : "pve-node",
13333 "type" : "string",
13334 "typetext" : "<string>"
13335 }
13336 }
13337 },
13338 "permissions" : {
13339 "user" : "all"
13340 },
13341 "returns" : {
13342 "items" : {
13343 "properties" : {
13344 "id" : {
13345 "type" : "string"
13346 }
13347 },
13348 "type" : "object"
13349 },
13350 "links" : [
13351 {
13352 "href" : "{id}",
13353 "rel" : "child"
13354 }
13355 ],
13356 "type" : "array"
13357 }
13358 }
13359 },
13360 "leaf" : 0,
13361 "path" : "/nodes/{node}/apt",
13362 "text" : "apt"
13363 },
13364 {
13365 "children" : [
13366 {
13367 "info" : {
13368 "GET" : {
13369 "allowtoken" : 1,
13370 "description" : "Get the detailed syslog entries for a specific mail ID.",
13371 "method" : "GET",
13372 "name" : "maillog",
13373 "parameters" : {
13374 "additionalProperties" : 0,
13375 "properties" : {
13376 "endtime" : {
13377 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
13378 "minimum" : 1,
13379 "optional" : 1,
13380 "type" : "integer",
13381 "typetext" : "<integer> (1 - N)"
13382 },
13383 "id" : {
13384 "description" : "Mail ID (as returned by the list API).",
13385 "maxLength" : 64,
13386 "minLength" : 3,
13387 "type" : "string",
13388 "typetext" : "<string>"
13389 },
13390 "node" : {
13391 "description" : "The cluster node name.",
13392 "format" : "pve-node",
13393 "type" : "string",
13394 "typetext" : "<string>"
13395 },
13396 "starttime" : {
13397 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
13398 "minimum" : 0,
13399 "optional" : 1,
13400 "type" : "integer",
13401 "typetext" : "<integer> (0 - N)"
13402 }
13403 }
13404 },
13405 "permissions" : {
13406 "check" : [
13407 "admin",
13408 "audit"
13409 ]
13410 },
13411 "protected" : 1,
13412 "proxyto" : "node",
13413 "returns" : {
13414 "properties" : {
13415 "client" : {
13416 "description" : "Client address",
13417 "optional" : 1,
13418 "type" : "string"
13419 },
13420 "dstatus" : {
13421 "description" : "Delivery status.",
13422 "maxLength" : 1,
13423 "minLength" : 1,
13424 "type" : "string"
13425 },
13426 "from" : {
13427 "description" : "Sender email address.",
13428 "type" : "string"
13429 },
13430 "id" : {
13431 "description" : "Unique ID.",
13432 "type" : "string"
13433 },
13434 "logs" : {
13435 "items" : {
13436 "type" : "string"
13437 },
13438 "type" : "array"
13439 },
13440 "msgid" : {
13441 "description" : "SMTP message ID.",
13442 "optional" : 1,
13443 "type" : "string"
13444 },
13445 "qid" : {
13446 "description" : "Postfix qmgr ID.",
13447 "optional" : 1,
13448 "type" : "string"
13449 },
13450 "relay" : {
13451 "description" : "ID of relayed mail.",
13452 "optional" : 1,
13453 "type" : "string"
13454 },
13455 "rstatus" : {
13456 "description" : "Delivery status of relayed mail.",
13457 "maxLength" : 1,
13458 "minLength" : 1,
13459 "optional" : 1,
13460 "type" : "string"
13461 },
13462 "size" : {
13463 "description" : "The size of the raw email.",
13464 "optional" : 1,
13465 "type" : "number"
13466 },
13467 "time" : {
13468 "description" : "Delivery timestamp.",
13469 "type" : "integer"
13470 },
13471 "to" : {
13472 "description" : "Receiver email address.",
13473 "type" : "string"
13474 }
13475 },
13476 "type" : "object"
13477 }
13478 }
13479 },
13480 "leaf" : 1,
13481 "path" : "/nodes/{node}/tracker/{id}",
13482 "text" : "{id}"
13483 }
13484 ],
13485 "info" : {
13486 "GET" : {
13487 "allowtoken" : 1,
13488 "description" : "Read mail list.",
13489 "method" : "GET",
13490 "name" : "list_mails",
13491 "parameters" : {
13492 "additionalProperties" : 0,
13493 "properties" : {
13494 "endtime" : {
13495 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
13496 "minimum" : 1,
13497 "optional" : 1,
13498 "type" : "integer",
13499 "typetext" : "<integer> (1 - N)"
13500 },
13501 "from" : {
13502 "description" : "Sender email address filter.",
13503 "maxLength" : 256,
13504 "minLength" : 1,
13505 "optional" : 1,
13506 "type" : "string",
13507 "typetext" : "<string>"
13508 },
13509 "greylist" : {
13510 "default" : 0,
13511 "description" : "Include Greylisted entries.",
13512 "optional" : 1,
13513 "type" : "boolean",
13514 "typetext" : "<boolean>"
13515 },
13516 "ndr" : {
13517 "default" : 0,
13518 "description" : "Include NDRs (non delivery reports).",
13519 "optional" : 1,
13520 "type" : "boolean",
13521 "typetext" : "<boolean>"
13522 },
13523 "node" : {
13524 "description" : "The cluster node name.",
13525 "format" : "pve-node",
13526 "type" : "string",
13527 "typetext" : "<string>"
13528 },
13529 "starttime" : {
13530 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
13531 "minimum" : 0,
13532 "optional" : 1,
13533 "type" : "integer",
13534 "typetext" : "<integer> (0 - N)"
13535 },
13536 "target" : {
13537 "description" : "Receiver email address filter.",
13538 "maxLength" : 256,
13539 "minLength" : 1,
13540 "optional" : 1,
13541 "type" : "string",
13542 "typetext" : "<string>"
13543 },
13544 "xfilter" : {
13545 "description" : "Only include mails containing this filter string.",
13546 "maxLength" : 256,
13547 "minLength" : 1,
13548 "optional" : 1,
13549 "type" : "string",
13550 "typetext" : "<string>"
13551 }
13552 }
13553 },
13554 "permissions" : {
13555 "check" : [
13556 "admin",
13557 "audit"
13558 ]
13559 },
13560 "protected" : 1,
13561 "proxyto" : "node",
13562 "returns" : {
13563 "items" : {
13564 "properties" : {
13565 "client" : {
13566 "description" : "Client address",
13567 "optional" : 1,
13568 "type" : "string"
13569 },
13570 "dstatus" : {
13571 "description" : "Delivery status.",
13572 "maxLength" : 1,
13573 "minLength" : 1,
13574 "type" : "string"
13575 },
13576 "from" : {
13577 "description" : "Sender email address.",
13578 "type" : "string"
13579 },
13580 "id" : {
13581 "description" : "Unique ID.",
13582 "type" : "string"
13583 },
13584 "msgid" : {
13585 "description" : "SMTP message ID.",
13586 "optional" : 1,
13587 "type" : "string"
13588 },
13589 "qid" : {
13590 "description" : "Postfix qmgr ID.",
13591 "optional" : 1,
13592 "type" : "string"
13593 },
13594 "relay" : {
13595 "description" : "ID of relayed mail.",
13596 "optional" : 1,
13597 "type" : "string"
13598 },
13599 "rstatus" : {
13600 "description" : "Delivery status of relayed mail.",
13601 "maxLength" : 1,
13602 "minLength" : 1,
13603 "optional" : 1,
13604 "type" : "string"
13605 },
13606 "size" : {
13607 "description" : "The size of the raw email.",
13608 "optional" : 1,
13609 "type" : "number"
13610 },
13611 "time" : {
13612 "description" : "Delivery timestamp.",
13613 "type" : "integer"
13614 },
13615 "to" : {
13616 "description" : "Receiver email address.",
13617 "type" : "string"
13618 }
13619 },
13620 "type" : "object"
13621 },
13622 "links" : [
13623 {
13624 "href" : "{id}",
13625 "rel" : "child"
13626 }
13627 ],
13628 "type" : "array"
13629 }
13630 }
13631 },
13632 "leaf" : 0,
13633 "path" : "/nodes/{node}/tracker",
13634 "text" : "tracker"
13635 },
13636 {
13637 "children" : [
13638 {
13639 "info" : {
13640 "DELETE" : {
13641 "allowtoken" : 1,
13642 "description" : "Delete a backup file.",
13643 "method" : "DELETE",
13644 "name" : "delete",
13645 "parameters" : {
13646 "additionalProperties" : 0,
13647 "properties" : {
13648 "filename" : {
13649 "description" : "The backup file name.",
13650 "maxLength" : 256,
13651 "minLength" : 4,
13652 "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
13653 "type" : "string"
13654 },
13655 "node" : {
13656 "description" : "The cluster node name.",
13657 "format" : "pve-node",
13658 "type" : "string",
13659 "typetext" : "<string>"
13660 }
13661 }
13662 },
13663 "permissions" : {
13664 "check" : [
13665 "admin"
13666 ]
13667 },
13668 "protected" : 1,
13669 "proxyto" : "node",
13670 "returns" : {
13671 "type" : "null"
13672 }
13673 },
13674 "GET" : {
13675 "allowtoken" : 1,
13676 "description" : "Download a backup file.",
13677 "download" : 1,
13678 "method" : "GET",
13679 "name" : "download",
13680 "parameters" : {
13681 "additionalProperties" : 0,
13682 "properties" : {
13683 "filename" : {
13684 "description" : "The backup file name.",
13685 "maxLength" : 256,
13686 "minLength" : 4,
13687 "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
13688 "type" : "string"
13689 },
13690 "node" : {
13691 "description" : "The cluster node name.",
13692 "format" : "pve-node",
13693 "type" : "string",
13694 "typetext" : "<string>"
13695 }
13696 }
13697 },
13698 "permissions" : {
13699 "check" : [
13700 "admin"
13701 ]
13702 },
13703 "protected" : 1,
13704 "proxyto" : "node",
13705 "returns" : {
13706 "type" : "string"
13707 }
13708 },
13709 "POST" : {
13710 "allowtoken" : 1,
13711 "description" : "Restore the system configuration.",
13712 "method" : "POST",
13713 "name" : "restore",
13714 "parameters" : {
13715 "additionalProperties" : 0,
13716 "properties" : {
13717 "config" : {
13718 "default" : 0,
13719 "description" : "Restore system configuration.",
13720 "optional" : 1,
13721 "type" : "boolean",
13722 "typetext" : "<boolean>"
13723 },
13724 "database" : {
13725 "default" : 1,
13726 "description" : "Restore the rule database. This is the default.",
13727 "optional" : 1,
13728 "type" : "boolean",
13729 "typetext" : "<boolean>"
13730 },
13731 "filename" : {
13732 "description" : "The backup file name.",
13733 "maxLength" : 256,
13734 "minLength" : 4,
13735 "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
13736 "type" : "string"
13737 },
13738 "node" : {
13739 "description" : "The cluster node name.",
13740 "format" : "pve-node",
13741 "type" : "string",
13742 "typetext" : "<string>"
13743 },
13744 "statistic" : {
13745 "default" : 0,
13746 "description" : "Restore statistic databases. Only considered when you restore the 'database'.",
13747 "optional" : 1,
13748 "type" : "boolean",
13749 "typetext" : "<boolean>"
13750 }
13751 }
13752 },
13753 "permissions" : {
13754 "check" : [
13755 "admin"
13756 ]
13757 },
13758 "protected" : 1,
13759 "proxyto" : "node",
13760 "returns" : {
13761 "type" : "string"
13762 }
13763 }
13764 },
13765 "leaf" : 1,
13766 "path" : "/nodes/{node}/backup/{filename}",
13767 "text" : "{filename}"
13768 }
13769 ],
13770 "info" : {
13771 "GET" : {
13772 "allowtoken" : 1,
13773 "description" : "List all stored backups (files named proxmox-backup_{DATE}.tgz).",
13774 "method" : "GET",
13775 "name" : "list",
13776 "parameters" : {
13777 "additionalProperties" : 0,
13778 "properties" : {
13779 "node" : {
13780 "description" : "The cluster node name.",
13781 "format" : "pve-node",
13782 "type" : "string",
13783 "typetext" : "<string>"
13784 }
13785 }
13786 },
13787 "permissions" : {
13788 "check" : [
13789 "admin",
13790 "audit"
13791 ]
13792 },
13793 "protected" : 1,
13794 "proxyto" : "node",
13795 "returns" : {
13796 "items" : {
13797 "properties" : {
13798 "filename" : {
13799 "description" : "The backup file name.",
13800 "maxLength" : 256,
13801 "minLength" : 4,
13802 "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
13803 "type" : "string"
13804 },
13805 "size" : {
13806 "description" : "Size of backup file in bytes.",
13807 "type" : "integer"
13808 },
13809 "timestamp" : {
13810 "description" : "Backup timestamp (Unix epoch).",
13811 "type" : "integer"
13812 }
13813 },
13814 "type" : "object"
13815 },
13816 "links" : [
13817 {
13818 "href" : "{filename}",
13819 "rel" : "child"
13820 }
13821 ],
13822 "type" : "array"
13823 }
13824 },
13825 "POST" : {
13826 "allowtoken" : 1,
13827 "description" : "Backup the system configuration.",
13828 "method" : "POST",
13829 "name" : "backup",
13830 "parameters" : {
13831 "additionalProperties" : 0,
13832 "properties" : {
13833 "node" : {
13834 "description" : "The cluster node name.",
13835 "format" : "pve-node",
13836 "type" : "string",
13837 "typetext" : "<string>"
13838 },
13839 "notify" : {
13840 "default" : "never",
13841 "description" : "Specify when to notify via e-mail",
13842 "enum" : [
13843 "always",
13844 "error",
13845 "never"
13846 ],
13847 "optional" : 1,
13848 "type" : "string"
13849 },
13850 "statistic" : {
13851 "default" : 1,
13852 "description" : "Backup statistic databases.",
13853 "optional" : 1,
13854 "type" : "boolean",
13855 "typetext" : "<boolean>"
13856 }
13857 }
13858 },
13859 "permissions" : {
13860 "check" : [
13861 "admin"
13862 ]
13863 },
13864 "protected" : 1,
13865 "proxyto" : "node",
13866 "returns" : {
13867 "type" : "string"
13868 }
13869 }
13870 },
13871 "leaf" : 0,
13872 "path" : "/nodes/{node}/backup",
13873 "text" : "backup"
13874 },
13875 {
13876 "children" : [
13877 {
13878 "children" : [
13879 {
13880 "children" : [
13881 {
13882 "children" : [
13883 {
13884 "info" : {
13885 "DELETE" : {
13886 "allowtoken" : 1,
13887 "description" : "Forget a snapshot",
13888 "method" : "DELETE",
13889 "name" : "forget_snapshot",
13890 "parameters" : {
13891 "additionalProperties" : 0,
13892 "properties" : {
13893 "backup-id" : {
13894 "description" : "ID (hostname) of backup snapshot",
13895 "type" : "string",
13896 "typetext" : "<string>"
13897 },
13898 "backup-time" : {
13899 "description" : "Backup time in RFC 3339 format",
13900 "type" : "string",
13901 "typetext" : "<string>"
13902 },
13903 "node" : {
13904 "description" : "The cluster node name.",
13905 "format" : "pve-node",
13906 "type" : "string",
13907 "typetext" : "<string>"
13908 },
13909 "remote" : {
13910 "description" : "Proxmox Backup Server ID.",
13911 "format" : "pve-configid",
13912 "type" : "string",
13913 "typetext" : "<string>"
13914 }
13915 }
13916 },
13917 "permissions" : {
13918 "check" : [
13919 "admin",
13920 "audit"
13921 ]
13922 },
13923 "protected" : 1,
13924 "proxyto" : "node",
13925 "returns" : {
13926 "type" : "null"
13927 }
13928 },
13929 "POST" : {
13930 "allowtoken" : 1,
13931 "description" : "Restore the system configuration.",
13932 "method" : "POST",
13933 "name" : "restore",
13934 "parameters" : {
13935 "additionalProperties" : 0,
13936 "properties" : {
13937 "backup-id" : {
13938 "description" : "backup-id (hostname) of backup snapshot",
13939 "type" : "string",
13940 "typetext" : "<string>"
13941 },
13942 "backup-time" : {
13943 "description" : "backup-time to restore",
13944 "type" : "string",
13945 "typetext" : "<string>"
13946 },
13947 "config" : {
13948 "default" : 0,
13949 "description" : "Restore system configuration.",
13950 "optional" : 1,
13951 "type" : "boolean",
13952 "typetext" : "<boolean>"
13953 },
13954 "database" : {
13955 "default" : 1,
13956 "description" : "Restore the rule database. This is the default.",
13957 "optional" : 1,
13958 "type" : "boolean",
13959 "typetext" : "<boolean>"
13960 },
13961 "node" : {
13962 "description" : "The cluster node name.",
13963 "format" : "pve-node",
13964 "type" : "string",
13965 "typetext" : "<string>"
13966 },
13967 "remote" : {
13968 "description" : "Proxmox Backup Server ID.",
13969 "format" : "pve-configid",
13970 "type" : "string",
13971 "typetext" : "<string>"
13972 },
13973 "statistic" : {
13974 "default" : 0,
13975 "description" : "Restore statistic databases. Only considered when you restore the 'database'.",
13976 "optional" : 1,
13977 "type" : "boolean",
13978 "typetext" : "<boolean>"
13979 }
13980 }
13981 },
13982 "permissions" : {
13983 "check" : [
13984 "admin"
13985 ]
13986 },
13987 "protected" : 1,
13988 "proxyto" : "node",
13989 "returns" : {
13990 "type" : "string"
13991 }
13992 }
13993 },
13994 "leaf" : 1,
13995 "path" : "/nodes/{node}/pbs/{remote}/snapshot/{backup-id}/{backup-time}",
13996 "text" : "{backup-time}"
13997 }
13998 ],
13999 "info" : {
14000 "GET" : {
14001 "allowtoken" : 1,
14002 "description" : "Get snapshots from a specific ID stored on remote.",
14003 "method" : "GET",
14004 "name" : "get_group_snapshots",
14005 "parameters" : {
14006 "additionalProperties" : 0,
14007 "properties" : {
14008 "backup-id" : {
14009 "description" : "ID (hostname) of backup snapshot",
14010 "type" : "string",
14011 "typetext" : "<string>"
14012 },
14013 "node" : {
14014 "description" : "The cluster node name.",
14015 "format" : "pve-node",
14016 "type" : "string",
14017 "typetext" : "<string>"
14018 },
14019 "remote" : {
14020 "description" : "Proxmox Backup Server ID.",
14021 "format" : "pve-configid",
14022 "type" : "string",
14023 "typetext" : "<string>"
14024 }
14025 }
14026 },
14027 "permissions" : {
14028 "check" : [
14029 "admin",
14030 "audit"
14031 ]
14032 },
14033 "protected" : 1,
14034 "proxyto" : "node",
14035 "returns" : {
14036 "items" : {
14037 "properties" : {
14038 "backup-id" : {
14039 "type" : "string"
14040 },
14041 "backup-time" : {
14042 "type" : "string"
14043 },
14044 "ctime" : {
14045 "type" : "string"
14046 },
14047 "size" : {
14048 "type" : "integer"
14049 }
14050 },
14051 "type" : "object"
14052 },
14053 "links" : [
14054 {
14055 "href" : "{backup-time}",
14056 "rel" : "child"
14057 }
14058 ],
14059 "type" : "array"
14060 }
14061 }
14062 },
14063 "leaf" : 0,
14064 "path" : "/nodes/{node}/pbs/{remote}/snapshot/{backup-id}",
14065 "text" : "{backup-id}"
14066 }
14067 ],
14068 "info" : {
14069 "GET" : {
14070 "allowtoken" : 1,
14071 "description" : "Get snapshots stored on remote.",
14072 "method" : "GET",
14073 "name" : "get_snapshots",
14074 "parameters" : {
14075 "additionalProperties" : 0,
14076 "properties" : {
14077 "node" : {
14078 "description" : "The cluster node name.",
14079 "format" : "pve-node",
14080 "type" : "string",
14081 "typetext" : "<string>"
14082 },
14083 "remote" : {
14084 "description" : "Proxmox Backup Server ID.",
14085 "format" : "pve-configid",
14086 "type" : "string",
14087 "typetext" : "<string>"
14088 }
14089 }
14090 },
14091 "permissions" : {
14092 "check" : [
14093 "admin",
14094 "audit"
14095 ]
14096 },
14097 "protected" : 1,
14098 "proxyto" : "node",
14099 "returns" : {
14100 "items" : {
14101 "properties" : {
14102 "backup-id" : {
14103 "type" : "string"
14104 },
14105 "backup-time" : {
14106 "type" : "string"
14107 },
14108 "ctime" : {
14109 "type" : "string"
14110 },
14111 "size" : {
14112 "type" : "integer"
14113 }
14114 },
14115 "type" : "object"
14116 },
14117 "links" : [
14118 {
14119 "href" : "{backup-id}",
14120 "rel" : "child"
14121 }
14122 ],
14123 "type" : "array"
14124 }
14125 },
14126 "POST" : {
14127 "allowtoken" : 1,
14128 "description" : "Create a new backup and prune the backup group afterwards, if configured.",
14129 "method" : "POST",
14130 "name" : "run_backup",
14131 "parameters" : {
14132 "additionalProperties" : 0,
14133 "properties" : {
14134 "node" : {
14135 "description" : "The cluster node name.",
14136 "format" : "pve-node",
14137 "type" : "string",
14138 "typetext" : "<string>"
14139 },
14140 "notify" : {
14141 "default" : "never",
14142 "description" : "Specify when to notify via e-mail",
14143 "enum" : [
14144 "always",
14145 "error",
14146 "never"
14147 ],
14148 "optional" : 1,
14149 "type" : "string"
14150 },
14151 "remote" : {
14152 "description" : "Proxmox Backup Server ID.",
14153 "format" : "pve-configid",
14154 "type" : "string",
14155 "typetext" : "<string>"
14156 },
14157 "statistic" : {
14158 "default" : 1,
14159 "description" : "Backup statistic databases.",
14160 "optional" : 1,
14161 "type" : "boolean",
14162 "typetext" : "<boolean>"
14163 }
14164 }
14165 },
14166 "permissions" : {
14167 "check" : [
14168 "admin",
14169 "audit"
14170 ]
14171 },
14172 "protected" : 1,
14173 "proxyto" : "node",
14174 "returns" : {
14175 "type" : "string"
14176 }
14177 }
14178 },
14179 "leaf" : 0,
14180 "path" : "/nodes/{node}/pbs/{remote}/snapshot",
14181 "text" : "snapshot"
14182 },
14183 {
14184 "info" : {
14185 "DELETE" : {
14186 "allowtoken" : 1,
14187 "description" : "Delete backup schedule",
14188 "method" : "DELETE",
14189 "name" : "delete_timer",
14190 "parameters" : {
14191 "additionalProperties" : 0,
14192 "properties" : {
14193 "node" : {
14194 "description" : "The cluster node name.",
14195 "format" : "pve-node",
14196 "type" : "string",
14197 "typetext" : "<string>"
14198 },
14199 "remote" : {
14200 "description" : "Proxmox Backup Server ID.",
14201 "format" : "pve-configid",
14202 "type" : "string",
14203 "typetext" : "<string>"
14204 }
14205 }
14206 },
14207 "permissions" : {
14208 "check" : [
14209 "admin",
14210 "audit"
14211 ]
14212 },
14213 "protected" : 1,
14214 "proxyto" : "node",
14215 "returns" : {
14216 "type" : "null"
14217 }
14218 },
14219 "GET" : {
14220 "allowtoken" : 1,
14221 "description" : "Get timer specification",
14222 "method" : "GET",
14223 "name" : "list_timer",
14224 "parameters" : {
14225 "additionalProperties" : 0,
14226 "properties" : {
14227 "node" : {
14228 "description" : "The cluster node name.",
14229 "format" : "pve-node",
14230 "type" : "string",
14231 "typetext" : "<string>"
14232 },
14233 "remote" : {
14234 "description" : "Proxmox Backup Server ID.",
14235 "format" : "pve-configid",
14236 "type" : "string",
14237 "typetext" : "<string>"
14238 }
14239 }
14240 },
14241 "permissions" : {
14242 "check" : [
14243 "admin",
14244 "audit"
14245 ]
14246 },
14247 "protected" : 1,
14248 "proxyto" : "node",
14249 "returns" : {
14250 "properties" : {
14251 "delay" : {
14252 "default" : "5min",
14253 "description" : "Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)",
14254 "optional" : 1,
14255 "pattern" : "[0-9a-zA-Z. ]+",
14256 "type" : "string"
14257 },
14258 "next-run" : {
14259 "description" : "The date time of the next run, in server locale.",
14260 "optional" : 1,
14261 "type" : "string"
14262 },
14263 "remote" : {
14264 "description" : "Proxmox Backup Server remote ID.",
14265 "format" : "pve-configid",
14266 "optional" : 1,
14267 "type" : "string"
14268 },
14269 "schedule" : {
14270 "default" : "daily",
14271 "description" : "Schedule for the backup (OnCalendar setting of the systemd.timer)",
14272 "optional" : 1,
14273 "pattern" : "[0-9a-zA-Z*.:,\\-/ ]+",
14274 "type" : "string"
14275 },
14276 "unitfile" : {
14277 "description" : "unit file for the systemd.timer unit",
14278 "optional" : 1,
14279 "type" : "string"
14280 }
14281 },
14282 "type" : "object"
14283 }
14284 },
14285 "POST" : {
14286 "allowtoken" : 1,
14287 "description" : "Create backup schedule",
14288 "method" : "POST",
14289 "name" : "create_timer",
14290 "parameters" : {
14291 "additionalProperties" : 0,
14292 "properties" : {
14293 "delay" : {
14294 "default" : "5min",
14295 "description" : "Randomized delay to add to the starttime (RandomizedDelaySec setting of the systemd.timer)",
14296 "optional" : 1,
14297 "pattern" : "[0-9a-zA-Z. ]+",
14298 "type" : "string"
14299 },
14300 "node" : {
14301 "description" : "The cluster node name.",
14302 "format" : "pve-node",
14303 "type" : "string",
14304 "typetext" : "<string>"
14305 },
14306 "remote" : {
14307 "description" : "Proxmox Backup Server ID.",
14308 "format" : "pve-configid",
14309 "type" : "string",
14310 "typetext" : "<string>"
14311 },
14312 "schedule" : {
14313 "default" : "daily",
14314 "description" : "Schedule for the backup (OnCalendar setting of the systemd.timer)",
14315 "optional" : 1,
14316 "pattern" : "[0-9a-zA-Z*.:,\\-/ ]+",
14317 "type" : "string"
14318 }
14319 }
14320 },
14321 "permissions" : {
14322 "check" : [
14323 "admin",
14324 "audit"
14325 ]
14326 },
14327 "protected" : 1,
14328 "proxyto" : "node",
14329 "returns" : {
14330 "type" : "null"
14331 }
14332 }
14333 },
14334 "leaf" : 1,
14335 "path" : "/nodes/{node}/pbs/{remote}/timer",
14336 "text" : "timer"
14337 }
14338 ],
14339 "info" : {
14340 "GET" : {
14341 "allowtoken" : 1,
14342 "description" : "Backup Job index.",
14343 "method" : "GET",
14344 "name" : "remote_index",
14345 "parameters" : {
14346 "additionalProperties" : 0,
14347 "properties" : {
14348 "node" : {
14349 "description" : "The cluster node name.",
14350 "format" : "pve-node",
14351 "type" : "string",
14352 "typetext" : "<string>"
14353 },
14354 "remote" : {
14355 "description" : "Proxmox Backup Server ID.",
14356 "format" : "pve-configid",
14357 "type" : "string",
14358 "typetext" : "<string>"
14359 }
14360 }
14361 },
14362 "returns" : {
14363 "items" : {
14364 "properties" : {
14365 "section" : {
14366 "type" : "string"
14367 }
14368 },
14369 "type" : "object"
14370 },
14371 "links" : [
14372 {
14373 "href" : "{section}",
14374 "rel" : "child"
14375 }
14376 ],
14377 "type" : "array"
14378 }
14379 }
14380 },
14381 "leaf" : 0,
14382 "path" : "/nodes/{node}/pbs/{remote}",
14383 "text" : "{remote}"
14384 }
14385 ],
14386 "info" : {
14387 "GET" : {
14388 "allowtoken" : 1,
14389 "description" : "List all configured Proxmox Backup Server jobs.",
14390 "method" : "GET",
14391 "name" : "list",
14392 "parameters" : {
14393 "additionalProperties" : 0,
14394 "properties" : {
14395 "node" : {
14396 "description" : "The cluster node name.",
14397 "format" : "pve-node",
14398 "type" : "string",
14399 "typetext" : "<string>"
14400 }
14401 }
14402 },
14403 "permissions" : {
14404 "check" : [
14405 "admin",
14406 "audit"
14407 ]
14408 },
14409 "protected" : 1,
14410 "proxyto" : "node",
14411 "returns" : {
14412 "items" : {
14413 "additionalProperties" : 0,
14414 "properties" : {
14415 "datastore" : {
14416 "description" : "Proxmox Backup Server datastore name.",
14417 "optional" : 0,
14418 "type" : "string"
14419 },
14420 "disable" : {
14421 "description" : "Flag to disable (deactivate) the entry.",
14422 "optional" : 1,
14423 "type" : "boolean"
14424 },
14425 "fingerprint" : {
14426 "description" : "Certificate SHA 256 fingerprint.",
14427 "optional" : 1,
14428 "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}",
14429 "type" : "string"
14430 },
14431 "include-statistics" : {
14432 "description" : "Include statistics in scheduled backups",
14433 "optional" : 1,
14434 "type" : "boolean"
14435 },
14436 "keep-daily" : {
14437 "description" : "Keep backups for the last <N> different days. If there is more than one backup for a single day, only the latest one is kept.",
14438 "format_description" : "N",
14439 "minimum" : "0",
14440 "optional" : 1,
14441 "type" : "integer"
14442 },
14443 "keep-hourly" : {
14444 "description" : "Keep backups for the last <N> different hours. If there is more than one backup for a single hour, only the latest one is kept.",
14445 "format_description" : "N",
14446 "minimum" : "0",
14447 "optional" : 1,
14448 "type" : "integer"
14449 },
14450 "keep-last" : {
14451 "description" : "Keep the last <N> backups.",
14452 "format_description" : "N",
14453 "minimum" : "0",
14454 "optional" : 1,
14455 "type" : "integer"
14456 },
14457 "keep-monthly" : {
14458 "description" : "Keep backups for the last <N> different months. If there is more than one backup for a single month, only the latest one is kept.",
14459 "format_description" : "N",
14460 "minimum" : "0",
14461 "optional" : 1,
14462 "type" : "integer"
14463 },
14464 "keep-weekly" : {
14465 "description" : "Keep backups for the last <N> different weeks. If there ismore than one backup for a single week, only the latest one is kept.",
14466 "format_description" : "N",
14467 "minimum" : "0",
14468 "optional" : 1,
14469 "type" : "integer"
14470 },
14471 "keep-yearly" : {
14472 "description" : "Keep backups for the last <N> different years. If there is more than one backup for a single year, only the latest one is kept.",
14473 "format_description" : "N",
14474 "minimum" : "0",
14475 "optional" : 1,
14476 "type" : "integer"
14477 },
14478 "notify" : {
14479 "description" : "Specify when to notify via e-mail",
14480 "enum" : [
14481 "always",
14482 "error",
14483 "never"
14484 ],
14485 "optional" : 1,
14486 "type" : "string"
14487 },
14488 "password" : {
14489 "description" : "Password or API token secret for the user on the Proxmox Backup Server.",
14490 "optional" : 1,
14491 "type" : "string"
14492 },
14493 "remote" : {
14494 "description" : "Proxmox Backup Server ID.",
14495 "format" : "pve-configid",
14496 "type" : "string"
14497 },
14498 "server" : {
14499 "description" : "Proxmox Backup Server address.",
14500 "format" : "address",
14501 "maxLength" : 256,
14502 "optional" : 0,
14503 "type" : "string"
14504 },
14505 "username" : {
14506 "description" : "Username or API token ID on the Proxmox Backup Server",
14507 "maxLength" : 512,
14508 "minLength" : 3,
14509 "optional" : 1,
14510 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
14511 "type" : "string"
14512 }
14513 },
14514 "type" : "object"
14515 },
14516 "links" : [
14517 {
14518 "href" : "{remote}",
14519 "rel" : "child"
14520 }
14521 ],
14522 "type" : "array"
14523 }
14524 }
14525 },
14526 "leaf" : 0,
14527 "path" : "/nodes/{node}/pbs",
14528 "text" : "pbs"
14529 },
14530 {
14531 "children" : [
14532 {
14533 "info" : {
14534 "GET" : {
14535 "allowtoken" : 1,
14536 "description" : "Get information about the node's certificates.",
14537 "method" : "GET",
14538 "name" : "info",
14539 "parameters" : {
14540 "additionalProperties" : 0,
14541 "properties" : {
14542 "node" : {
14543 "description" : "The cluster node name.",
14544 "format" : "pve-node",
14545 "type" : "string",
14546 "typetext" : "<string>"
14547 }
14548 }
14549 },
14550 "permissions" : {
14551 "user" : "all"
14552 },
14553 "protected" : 1,
14554 "proxyto" : "node",
14555 "returns" : {
14556 "items" : {
14557 "properties" : {
14558 "filename" : {
14559 "optional" : 1,
14560 "type" : "string"
14561 },
14562 "fingerprint" : {
14563 "description" : "Certificate SHA 256 fingerprint.",
14564 "optional" : 1,
14565 "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}",
14566 "type" : "string"
14567 },
14568 "issuer" : {
14569 "description" : "Certificate issuer name.",
14570 "optional" : 1,
14571 "type" : "string"
14572 },
14573 "notafter" : {
14574 "description" : "Certificate's notAfter timestamp (UNIX epoch).",
14575 "optional" : 1,
14576 "renderer" : "timestamp",
14577 "type" : "integer"
14578 },
14579 "notbefore" : {
14580 "description" : "Certificate's notBefore timestamp (UNIX epoch).",
14581 "optional" : 1,
14582 "renderer" : "timestamp",
14583 "type" : "integer"
14584 },
14585 "pem" : {
14586 "description" : "Certificate in PEM format",
14587 "format" : "pem-certificate",
14588 "optional" : 1,
14589 "type" : "string"
14590 },
14591 "public-key-bits" : {
14592 "description" : "Certificate's public key size",
14593 "optional" : 1,
14594 "type" : "integer"
14595 },
14596 "public-key-type" : {
14597 "description" : "Certificate's public key algorithm",
14598 "optional" : 1,
14599 "type" : "string"
14600 },
14601 "san" : {
14602 "description" : "List of Certificate's SubjectAlternativeName entries.",
14603 "items" : {
14604 "type" : "string"
14605 },
14606 "optional" : 1,
14607 "renderer" : "yaml",
14608 "type" : "array"
14609 },
14610 "subject" : {
14611 "description" : "Certificate subject name.",
14612 "optional" : 1,
14613 "type" : "string"
14614 }
14615 },
14616 "type" : "object"
14617 },
14618 "type" : "array"
14619 }
14620 }
14621 },
14622 "leaf" : 1,
14623 "path" : "/nodes/{node}/certificates/info",
14624 "text" : "info"
14625 },
14626 {
14627 "children" : [
14628 {
14629 "info" : {
14630 "DELETE" : {
14631 "allowtoken" : 1,
14632 "description" : "DELETE custom certificate chain and key.",
14633 "method" : "DELETE",
14634 "name" : "remove_custom_cert",
14635 "parameters" : {
14636 "additionalProperties" : 0,
14637 "properties" : {
14638 "node" : {
14639 "description" : "The cluster node name.",
14640 "format" : "pve-node",
14641 "type" : "string",
14642 "typetext" : "<string>"
14643 },
14644 "restart" : {
14645 "default" : 0,
14646 "description" : "Restart pmgproxy.",
14647 "optional" : 1,
14648 "type" : "boolean",
14649 "typetext" : "<boolean>"
14650 },
14651 "type" : {
14652 "description" : "The TLS certificate type (API or SMTP certificate).",
14653 "enum" : [
14654 "api",
14655 "smtp"
14656 ],
14657 "type" : "string"
14658 }
14659 }
14660 },
14661 "permissions" : {
14662 "check" : [
14663 "admin"
14664 ]
14665 },
14666 "protected" : 1,
14667 "proxyto" : "node",
14668 "returns" : {
14669 "type" : "null"
14670 }
14671 },
14672 "POST" : {
14673 "allowtoken" : 1,
14674 "description" : "Upload or update custom certificate chain and key.",
14675 "method" : "POST",
14676 "name" : "upload_custom_cert",
14677 "parameters" : {
14678 "additionalProperties" : 0,
14679 "properties" : {
14680 "certificates" : {
14681 "description" : "PEM encoded certificate (chain).",
14682 "format" : "pem-certificate-chain",
14683 "type" : "string",
14684 "typetext" : "<string>"
14685 },
14686 "force" : {
14687 "default" : 0,
14688 "description" : "Overwrite existing custom or ACME certificate files.",
14689 "optional" : 1,
14690 "type" : "boolean",
14691 "typetext" : "<boolean>"
14692 },
14693 "key" : {
14694 "description" : "PEM encoded private key.",
14695 "format" : "pem-string",
14696 "optional" : 0,
14697 "type" : "string",
14698 "typetext" : "<string>"
14699 },
14700 "node" : {
14701 "description" : "The cluster node name.",
14702 "format" : "pve-node",
14703 "type" : "string",
14704 "typetext" : "<string>"
14705 },
14706 "restart" : {
14707 "default" : 0,
14708 "description" : "Restart services.",
14709 "optional" : 1,
14710 "type" : "boolean",
14711 "typetext" : "<boolean>"
14712 },
14713 "type" : {
14714 "description" : "The TLS certificate type (API or SMTP certificate).",
14715 "enum" : [
14716 "api",
14717 "smtp"
14718 ],
14719 "type" : "string"
14720 }
14721 }
14722 },
14723 "permissions" : {
14724 "check" : [
14725 "admin"
14726 ]
14727 },
14728 "protected" : 1,
14729 "proxyto" : "node",
14730 "returns" : {
14731 "properties" : {
14732 "filename" : {
14733 "optional" : 1,
14734 "type" : "string"
14735 },
14736 "fingerprint" : {
14737 "description" : "Certificate SHA 256 fingerprint.",
14738 "optional" : 1,
14739 "pattern" : "([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}",
14740 "type" : "string"
14741 },
14742 "issuer" : {
14743 "description" : "Certificate issuer name.",
14744 "optional" : 1,
14745 "type" : "string"
14746 },
14747 "notafter" : {
14748 "description" : "Certificate's notAfter timestamp (UNIX epoch).",
14749 "optional" : 1,
14750 "renderer" : "timestamp",
14751 "type" : "integer"
14752 },
14753 "notbefore" : {
14754 "description" : "Certificate's notBefore timestamp (UNIX epoch).",
14755 "optional" : 1,
14756 "renderer" : "timestamp",
14757 "type" : "integer"
14758 },
14759 "pem" : {
14760 "description" : "Certificate in PEM format",
14761 "format" : "pem-certificate",
14762 "optional" : 1,
14763 "type" : "string"
14764 },
14765 "public-key-bits" : {
14766 "description" : "Certificate's public key size",
14767 "optional" : 1,
14768 "type" : "integer"
14769 },
14770 "public-key-type" : {
14771 "description" : "Certificate's public key algorithm",
14772 "optional" : 1,
14773 "type" : "string"
14774 },
14775 "san" : {
14776 "description" : "List of Certificate's SubjectAlternativeName entries.",
14777 "items" : {
14778 "type" : "string"
14779 },
14780 "optional" : 1,
14781 "renderer" : "yaml",
14782 "type" : "array"
14783 },
14784 "subject" : {
14785 "description" : "Certificate subject name.",
14786 "optional" : 1,
14787 "type" : "string"
14788 }
14789 },
14790 "type" : "object"
14791 }
14792 }
14793 },
14794 "leaf" : 1,
14795 "path" : "/nodes/{node}/certificates/custom/{type}",
14796 "text" : "{type}"
14797 }
14798 ],
14799 "info" : {
14800 "GET" : {
14801 "allowtoken" : 1,
14802 "description" : "Certificate index.",
14803 "method" : "GET",
14804 "name" : "custom_cert_index",
14805 "parameters" : {
14806 "additionalProperties" : 0,
14807 "properties" : {
14808 "node" : {
14809 "description" : "The cluster node name.",
14810 "format" : "pve-node",
14811 "type" : "string",
14812 "typetext" : "<string>"
14813 }
14814 }
14815 },
14816 "permissions" : {
14817 "user" : "all"
14818 },
14819 "returns" : {
14820 "items" : {
14821 "properties" : {},
14822 "type" : "object"
14823 },
14824 "links" : [
14825 {
14826 "href" : "{type}",
14827 "rel" : "child"
14828 }
14829 ],
14830 "type" : "array"
14831 }
14832 }
14833 },
14834 "leaf" : 0,
14835 "path" : "/nodes/{node}/certificates/custom",
14836 "text" : "custom"
14837 },
14838 {
14839 "children" : [
14840 {
14841 "info" : {
14842 "DELETE" : {
14843 "allowtoken" : 1,
14844 "description" : "Revoke existing certificate from CA.",
14845 "method" : "DELETE",
14846 "name" : "revoke_acme_cert",
14847 "parameters" : {
14848 "additionalProperties" : 0,
14849 "properties" : {
14850 "node" : {
14851 "description" : "The cluster node name.",
14852 "format" : "pve-node",
14853 "type" : "string",
14854 "typetext" : "<string>"
14855 },
14856 "type" : {
14857 "description" : "The TLS certificate type (API or SMTP certificate).",
14858 "enum" : [
14859 "api",
14860 "smtp"
14861 ],
14862 "type" : "string"
14863 }
14864 }
14865 },
14866 "permissions" : {
14867 "check" : [
14868 "admin"
14869 ]
14870 },
14871 "protected" : 1,
14872 "proxyto" : "node",
14873 "returns" : {
14874 "type" : "string"
14875 }
14876 },
14877 "POST" : {
14878 "allowtoken" : 1,
14879 "description" : "Order a new certificate from ACME-compatible CA.",
14880 "method" : "POST",
14881 "name" : "new_acme_cert",
14882 "parameters" : {
14883 "additionalProperties" : 0,
14884 "properties" : {
14885 "force" : {
14886 "default" : 0,
14887 "description" : "Overwrite existing custom certificate.",
14888 "optional" : 1,
14889 "type" : "boolean",
14890 "typetext" : "<boolean>"
14891 },
14892 "node" : {
14893 "description" : "The cluster node name.",
14894 "format" : "pve-node",
14895 "type" : "string",
14896 "typetext" : "<string>"
14897 },
14898 "type" : {
14899 "description" : "The TLS certificate type (API or SMTP certificate).",
14900 "enum" : [
14901 "api",
14902 "smtp"
14903 ],
14904 "type" : "string"
14905 }
14906 }
14907 },
14908 "permissions" : {
14909 "check" : [
14910 "admin"
14911 ]
14912 },
14913 "protected" : 1,
14914 "proxyto" : "node",
14915 "returns" : {
14916 "type" : "string"
14917 }
14918 },
14919 "PUT" : {
14920 "allowtoken" : 1,
14921 "description" : "Renew existing certificate from CA.",
14922 "method" : "PUT",
14923 "name" : "renew_acme_cert",
14924 "parameters" : {
14925 "additionalProperties" : 0,
14926 "properties" : {
14927 "force" : {
14928 "default" : 0,
14929 "description" : "Force renewal even if expiry is more than 30 days away.",
14930 "optional" : 1,
14931 "type" : "boolean",
14932 "typetext" : "<boolean>"
14933 },
14934 "node" : {
14935 "description" : "The cluster node name.",
14936 "format" : "pve-node",
14937 "type" : "string",
14938 "typetext" : "<string>"
14939 },
14940 "type" : {
14941 "description" : "The TLS certificate type (API or SMTP certificate).",
14942 "enum" : [
14943 "api",
14944 "smtp"
14945 ],
14946 "type" : "string"
14947 }
14948 }
14949 },
14950 "permissions" : {
14951 "check" : [
14952 "admin"
14953 ]
14954 },
14955 "protected" : 1,
14956 "proxyto" : "node",
14957 "returns" : {
14958 "type" : "string"
14959 }
14960 }
14961 },
14962 "leaf" : 1,
14963 "path" : "/nodes/{node}/certificates/acme/{type}",
14964 "text" : "{type}"
14965 }
14966 ],
14967 "info" : {
14968 "GET" : {
14969 "allowtoken" : 1,
14970 "description" : "ACME Certificate index.",
14971 "method" : "GET",
14972 "name" : "acme_cert_index",
14973 "parameters" : {
14974 "additionalProperties" : 0,
14975 "properties" : {
14976 "node" : {
14977 "description" : "The cluster node name.",
14978 "format" : "pve-node",
14979 "type" : "string",
14980 "typetext" : "<string>"
14981 }
14982 }
14983 },
14984 "permissions" : {
14985 "user" : "all"
14986 },
14987 "returns" : {
14988 "items" : {
14989 "properties" : {},
14990 "type" : "object"
14991 },
14992 "links" : [
14993 {
14994 "href" : "{type}",
14995 "rel" : "child"
14996 }
14997 ],
14998 "type" : "array"
14999 }
15000 }
15001 },
15002 "leaf" : 0,
15003 "path" : "/nodes/{node}/certificates/acme",
15004 "text" : "acme"
15005 }
15006 ],
15007 "info" : {
15008 "GET" : {
15009 "allowtoken" : 1,
15010 "description" : "Node index.",
15011 "method" : "GET",
15012 "name" : "index",
15013 "parameters" : {
15014 "additionalProperties" : 0,
15015 "properties" : {
15016 "node" : {
15017 "description" : "The cluster node name.",
15018 "format" : "pve-node",
15019 "type" : "string",
15020 "typetext" : "<string>"
15021 }
15022 }
15023 },
15024 "permissions" : {
15025 "user" : "all"
15026 },
15027 "returns" : {
15028 "items" : {
15029 "properties" : {},
15030 "type" : "object"
15031 },
15032 "links" : [
15033 {
15034 "href" : "{name}",
15035 "rel" : "child"
15036 }
15037 ],
15038 "type" : "array"
15039 }
15040 }
15041 },
15042 "leaf" : 0,
15043 "path" : "/nodes/{node}/certificates",
15044 "text" : "certificates"
15045 },
15046 {
15047 "info" : {
15048 "GET" : {
15049 "allowtoken" : 1,
15050 "description" : "Get node configuration options.",
15051 "method" : "GET",
15052 "name" : "get_config",
15053 "parameters" : {
15054 "additionalProperties" : 0,
15055 "properties" : {
15056 "node" : {
15057 "description" : "The cluster node name.",
15058 "format" : "pve-node",
15059 "type" : "string",
15060 "typetext" : "<string>"
15061 }
15062 }
15063 },
15064 "permissions" : {
15065 "check" : [
15066 "admin",
15067 "audit"
15068 ]
15069 },
15070 "protected" : 1,
15071 "proxyto" : "node",
15072 "returns" : {
15073 "additionalProperties" : 0,
15074 "properties" : {
15075 "acme" : {
15076 "description" : "Node specific ACME settings.",
15077 "format" : {
15078 "account" : {
15079 "default" : "default",
15080 "description" : "ACME account config file name.",
15081 "format" : "pve-configid",
15082 "format_description" : "name",
15083 "optional" : 1,
15084 "type" : "string"
15085 }
15086 },
15087 "optional" : 1,
15088 "type" : "string"
15089 },
15090 "acmedomain[n]" : {
15091 "description" : "ACME domain and validation plugin",
15092 "format" : {
15093 "alias" : {
15094 "description" : "Alias for the Domain to verify ACME Challenge over DNS",
15095 "format" : "pmg-acme-alias",
15096 "format_description" : "domain",
15097 "optional" : 1,
15098 "type" : "string"
15099 },
15100 "domain" : {
15101 "default_key" : 1,
15102 "description" : "domain for this node's ACME certificate",
15103 "format" : "pmg-acme-domain",
15104 "format_description" : "domain",
15105 "type" : "string"
15106 },
15107 "plugin" : {
15108 "default" : "standalone",
15109 "description" : "The ACME plugin ID",
15110 "format" : "pve-configid",
15111 "format_description" : "name of the plugin configuration",
15112 "optional" : 1,
15113 "type" : "string"
15114 },
15115 "usage" : {
15116 "description" : "Whether this domain is used for the API, SMTP or both",
15117 "format" : "pmg-certificate-type-list",
15118 "format_description" : "usage list",
15119 "type" : "string"
15120 }
15121 },
15122 "optional" : 1,
15123 "type" : "string"
15124 },
15125 "digest" : {
15126 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
15127 "maxLength" : 40,
15128 "optional" : 1,
15129 "type" : "string"
15130 }
15131 },
15132 "type" : "object"
15133 }
15134 },
15135 "PUT" : {
15136 "allowtoken" : 1,
15137 "description" : "Set node configuration options.",
15138 "method" : "PUT",
15139 "name" : "set_config",
15140 "parameters" : {
15141 "additionalProperties" : 0,
15142 "properties" : {
15143 "acme" : {
15144 "description" : "Node specific ACME settings.",
15145 "format" : {
15146 "account" : {
15147 "default" : "default",
15148 "description" : "ACME account config file name.",
15149 "format" : "pve-configid",
15150 "format_description" : "name",
15151 "optional" : 1,
15152 "type" : "string"
15153 }
15154 },
15155 "optional" : 1,
15156 "type" : "string",
15157 "typetext" : "[account=<name>]"
15158 },
15159 "acmedomain[n]" : {
15160 "description" : "ACME domain and validation plugin",
15161 "format" : {
15162 "alias" : {
15163 "description" : "Alias for the Domain to verify ACME Challenge over DNS",
15164 "format" : "pmg-acme-alias",
15165 "format_description" : "domain",
15166 "optional" : 1,
15167 "type" : "string"
15168 },
15169 "domain" : {
15170 "default_key" : 1,
15171 "description" : "domain for this node's ACME certificate",
15172 "format" : "pmg-acme-domain",
15173 "format_description" : "domain",
15174 "type" : "string"
15175 },
15176 "plugin" : {
15177 "default" : "standalone",
15178 "description" : "The ACME plugin ID",
15179 "format" : "pve-configid",
15180 "format_description" : "name of the plugin configuration",
15181 "optional" : 1,
15182 "type" : "string"
15183 },
15184 "usage" : {
15185 "description" : "Whether this domain is used for the API, SMTP or both",
15186 "format" : "pmg-certificate-type-list",
15187 "format_description" : "usage list",
15188 "type" : "string"
15189 }
15190 },
15191 "optional" : 1,
15192 "type" : "string",
15193 "typetext" : "[domain=]<domain> ,usage=<usage list> [,alias=<domain>] [,plugin=<name of the plugin configuration>]"
15194 },
15195 "delete" : {
15196 "description" : "A list of settings you want to delete.",
15197 "format" : "pve-configid-list",
15198 "optional" : 1,
15199 "type" : "string",
15200 "typetext" : "<string>"
15201 },
15202 "digest" : {
15203 "description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
15204 "maxLength" : 40,
15205 "optional" : 1,
15206 "type" : "string",
15207 "typetext" : "<string>"
15208 },
15209 "node" : {
15210 "description" : "The cluster node name.",
15211 "format" : "pve-node",
15212 "type" : "string",
15213 "typetext" : "<string>"
15214 }
15215 },
15216 "type" : "object"
15217 },
15218 "permissions" : {
15219 "check" : [
15220 "admin",
15221 "audit"
15222 ]
15223 },
15224 "protected" : 1,
15225 "proxyto" : "node",
15226 "returns" : {
15227 "type" : "null"
15228 }
15229 }
15230 },
15231 "leaf" : 1,
15232 "path" : "/nodes/{node}/config",
15233 "text" : "config"
15234 },
15235 {
15236 "info" : {
15237 "GET" : {
15238 "allowtoken" : 1,
15239 "description" : "Gather various system information about a node",
15240 "method" : "GET",
15241 "name" : "report",
15242 "parameters" : {
15243 "additionalProperties" : 0,
15244 "properties" : {
15245 "node" : {
15246 "description" : "The cluster node name.",
15247 "format" : "pve-node",
15248 "type" : "string",
15249 "typetext" : "<string>"
15250 }
15251 }
15252 },
15253 "permissions" : {
15254 "check" : [
15255 "admin",
15256 "audit"
15257 ]
15258 },
15259 "protected" : 1,
15260 "proxyto" : "node",
15261 "returns" : {
15262 "type" : "string"
15263 }
15264 }
15265 },
15266 "leaf" : 1,
15267 "path" : "/nodes/{node}/report",
15268 "text" : "report"
15269 },
15270 {
15271 "info" : {
15272 "GET" : {
15273 "allowtoken" : 1,
15274 "description" : "Read node RRD statistics",
15275 "method" : "GET",
15276 "name" : "rrddata",
15277 "parameters" : {
15278 "additionalProperties" : 0,
15279 "properties" : {
15280 "cf" : {
15281 "description" : "The RRD consolidation function",
15282 "enum" : [
15283 "AVERAGE",
15284 "MAX"
15285 ],
15286 "optional" : 1,
15287 "type" : "string"
15288 },
15289 "node" : {
15290 "description" : "The cluster node name.",
15291 "format" : "pve-node",
15292 "type" : "string",
15293 "typetext" : "<string>"
15294 },
15295 "timeframe" : {
15296 "description" : "Specify the time frame you are interested in.",
15297 "enum" : [
15298 "hour",
15299 "day",
15300 "week",
15301 "month",
15302 "year"
15303 ],
15304 "type" : "string"
15305 }
15306 }
15307 },
15308 "permissions" : {
15309 "check" : [
15310 "admin",
15311 "audit"
15312 ]
15313 },
15314 "protected" : 1,
15315 "proxyto" : "node",
15316 "returns" : {
15317 "items" : {
15318 "properties" : {},
15319 "type" : "object"
15320 },
15321 "type" : "array"
15322 }
15323 }
15324 },
15325 "leaf" : 1,
15326 "path" : "/nodes/{node}/rrddata",
15327 "text" : "rrddata"
15328 },
15329 {
15330 "info" : {
15331 "GET" : {
15332 "allowtoken" : 1,
15333 "description" : "Read system log",
15334 "method" : "GET",
15335 "name" : "syslog",
15336 "parameters" : {
15337 "additionalProperties" : 0,
15338 "properties" : {
15339 "limit" : {
15340 "minimum" : 0,
15341 "optional" : 1,
15342 "type" : "integer",
15343 "typetext" : "<integer> (0 - N)"
15344 },
15345 "node" : {
15346 "description" : "The cluster node name.",
15347 "format" : "pve-node",
15348 "type" : "string",
15349 "typetext" : "<string>"
15350 },
15351 "service" : {
15352 "description" : "Service ID",
15353 "maxLength" : 128,
15354 "optional" : 1,
15355 "type" : "string",
15356 "typetext" : "<string>"
15357 },
15358 "since" : {
15359 "description" : "Display all log since this date-time string.",
15360 "optional" : 1,
15361 "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$",
15362 "type" : "string"
15363 },
15364 "start" : {
15365 "minimum" : 0,
15366 "optional" : 1,
15367 "type" : "integer",
15368 "typetext" : "<integer> (0 - N)"
15369 },
15370 "until" : {
15371 "description" : "Display all log until this date-time string.",
15372 "optional" : 1,
15373 "pattern" : "^\\d{4}-\\d{2}-\\d{2}( \\d{2}:\\d{2}(:\\d{2})?)?$",
15374 "type" : "string"
15375 }
15376 }
15377 },
15378 "permissions" : {
15379 "check" : [
15380 "admin",
15381 "audit"
15382 ]
15383 },
15384 "protected" : 1,
15385 "proxyto" : "node",
15386 "returns" : {
15387 "items" : {
15388 "properties" : {
15389 "n" : {
15390 "description" : "Line number",
15391 "type" : "integer"
15392 },
15393 "t" : {
15394 "description" : "Line text",
15395 "type" : "string"
15396 }
15397 },
15398 "type" : "object"
15399 },
15400 "type" : "array"
15401 }
15402 }
15403 },
15404 "leaf" : 1,
15405 "path" : "/nodes/{node}/syslog",
15406 "text" : "syslog"
15407 },
15408 {
15409 "info" : {
15410 "GET" : {
15411 "allowtoken" : 1,
15412 "description" : "Read Journal",
15413 "method" : "GET",
15414 "name" : "journal",
15415 "parameters" : {
15416 "additionalProperties" : 0,
15417 "properties" : {
15418 "endcursor" : {
15419 "description" : "End before the given Cursor. Conflicts with 'until'.",
15420 "optional" : 1,
15421 "type" : "string",
15422 "typetext" : "<string>"
15423 },
15424 "lastentries" : {
15425 "description" : "Limit to the last X lines. Conflicts with a range.",
15426 "minimum" : 0,
15427 "optional" : 1,
15428 "type" : "integer",
15429 "typetext" : "<integer> (0 - N)"
15430 },
15431 "node" : {
15432 "description" : "The cluster node name.",
15433 "format" : "pve-node",
15434 "type" : "string",
15435 "typetext" : "<string>"
15436 },
15437 "since" : {
15438 "description" : "Display all log since this UNIX epoch. Conflicts with 'startcursor'.",
15439 "minimum" : 0,
15440 "optional" : 1,
15441 "type" : "integer",
15442 "typetext" : "<integer> (0 - N)"
15443 },
15444 "startcursor" : {
15445 "description" : "Start after the given Cursor. Conflicts with 'since'.",
15446 "optional" : 1,
15447 "type" : "string",
15448 "typetext" : "<string>"
15449 },
15450 "until" : {
15451 "description" : "Display all log until this UNIX epoch. Conflicts with 'endcursor'.",
15452 "minimum" : 0,
15453 "optional" : 1,
15454 "type" : "integer",
15455 "typetext" : "<integer> (0 - N)"
15456 }
15457 }
15458 },
15459 "permissions" : {
15460 "check" : [
15461 "admin",
15462 "audit"
15463 ]
15464 },
15465 "protected" : 1,
15466 "proxyto" : "node",
15467 "returns" : {
15468 "items" : {
15469 "type" : "string"
15470 },
15471 "type" : "array"
15472 }
15473 }
15474 },
15475 "leaf" : 1,
15476 "path" : "/nodes/{node}/journal",
15477 "text" : "journal"
15478 },
15479 {
15480 "info" : {
15481 "POST" : {
15482 "allowtoken" : 1,
15483 "description" : "Creates a Terminal proxy.",
15484 "method" : "POST",
15485 "name" : "termproxy",
15486 "parameters" : {
15487 "additionalProperties" : 0,
15488 "properties" : {
15489 "cmd" : {
15490 "default" : "login",
15491 "description" : "Run specific command or default to login.",
15492 "enum" : [
15493 "login",
15494 "upgrade"
15495 ],
15496 "optional" : 1,
15497 "type" : "string"
15498 },
15499 "cmd-opts" : {
15500 "default" : "",
15501 "description" : "Add parameters to a command. Encoded as null terminated strings.",
15502 "optional" : 1,
15503 "requires" : "cmd",
15504 "type" : "string",
15505 "typetext" : "<string>"
15506 },
15507 "node" : {
15508 "description" : "The cluster node name.",
15509 "format" : "pve-node",
15510 "type" : "string",
15511 "typetext" : "<string>"
15512 }
15513 }
15514 },
15515 "permissions" : {
15516 "check" : [
15517 "admin"
15518 ]
15519 },
15520 "protected" : 1,
15521 "returns" : {
15522 "additionalProperties" : 0,
15523 "properties" : {
15524 "port" : {
15525 "type" : "integer"
15526 },
15527 "ticket" : {
15528 "type" : "string"
15529 },
15530 "upid" : {
15531 "type" : "string"
15532 },
15533 "user" : {
15534 "type" : "string"
15535 }
15536 }
15537 }
15538 }
15539 },
15540 "leaf" : 1,
15541 "path" : "/nodes/{node}/termproxy",
15542 "text" : "termproxy"
15543 },
15544 {
15545 "info" : {
15546 "GET" : {
15547 "allowtoken" : 1,
15548 "description" : "Opens a weksocket for VNC traffic.",
15549 "method" : "GET",
15550 "name" : "vncwebsocket",
15551 "parameters" : {
15552 "additionalProperties" : 0,
15553 "properties" : {
15554 "node" : {
15555 "description" : "The cluster node name.",
15556 "format" : "pve-node",
15557 "type" : "string",
15558 "typetext" : "<string>"
15559 },
15560 "port" : {
15561 "description" : "Port number returned by previous vncproxy call.",
15562 "maximum" : 5999,
15563 "minimum" : 5900,
15564 "type" : "integer",
15565 "typetext" : "<integer> (5900 - 5999)"
15566 },
15567 "vncticket" : {
15568 "description" : "Ticket from previous call to vncproxy.",
15569 "maxLength" : 512,
15570 "type" : "string",
15571 "typetext" : "<string>"
15572 }
15573 }
15574 },
15575 "permissions" : {
15576 "check" : [
15577 "admin"
15578 ]
15579 },
15580 "returns" : {
15581 "properties" : {
15582 "port" : {
15583 "type" : "string"
15584 }
15585 },
15586 "type" : "object"
15587 }
15588 }
15589 },
15590 "leaf" : 1,
15591 "path" : "/nodes/{node}/vncwebsocket",
15592 "text" : "vncwebsocket"
15593 },
15594 {
15595 "info" : {
15596 "GET" : {
15597 "allowtoken" : 1,
15598 "description" : "Read DNS settings.",
15599 "method" : "GET",
15600 "name" : "dns",
15601 "parameters" : {
15602 "additionalProperties" : 0,
15603 "properties" : {
15604 "node" : {
15605 "description" : "The cluster node name.",
15606 "format" : "pve-node",
15607 "type" : "string",
15608 "typetext" : "<string>"
15609 }
15610 }
15611 },
15612 "permissions" : {
15613 "check" : [
15614 "admin",
15615 "audit"
15616 ]
15617 },
15618 "proxyto" : "node",
15619 "returns" : {
15620 "additionalProperties" : 0,
15621 "properties" : {
15622 "dns1" : {
15623 "description" : "First name server IP address.",
15624 "optional" : 1,
15625 "type" : "string"
15626 },
15627 "dns2" : {
15628 "description" : "Second name server IP address.",
15629 "optional" : 1,
15630 "type" : "string"
15631 },
15632 "dns3" : {
15633 "description" : "Third name server IP address.",
15634 "optional" : 1,
15635 "type" : "string"
15636 },
15637 "search" : {
15638 "description" : "Search domain for host-name lookup.",
15639 "optional" : 1,
15640 "type" : "string"
15641 }
15642 },
15643 "type" : "object"
15644 }
15645 },
15646 "PUT" : {
15647 "allowtoken" : 1,
15648 "description" : "Write DNS settings.",
15649 "method" : "PUT",
15650 "name" : "update_dns",
15651 "parameters" : {
15652 "additionalProperties" : 0,
15653 "properties" : {
15654 "dns1" : {
15655 "description" : "First name server IP address.",
15656 "format" : "ip",
15657 "optional" : 1,
15658 "type" : "string",
15659 "typetext" : "<string>"
15660 },
15661 "dns2" : {
15662 "description" : "Second name server IP address.",
15663 "format" : "ip",
15664 "optional" : 1,
15665 "type" : "string",
15666 "typetext" : "<string>"
15667 },
15668 "dns3" : {
15669 "description" : "Third name server IP address.",
15670 "format" : "ip",
15671 "optional" : 1,
15672 "type" : "string",
15673 "typetext" : "<string>"
15674 },
15675 "node" : {
15676 "description" : "The cluster node name.",
15677 "format" : "pve-node",
15678 "type" : "string",
15679 "typetext" : "<string>"
15680 },
15681 "search" : {
15682 "description" : "Search domain for host-name lookup.",
15683 "type" : "string",
15684 "typetext" : "<string>"
15685 }
15686 }
15687 },
15688 "protected" : 1,
15689 "proxyto" : "node",
15690 "returns" : {
15691 "type" : "null"
15692 }
15693 }
15694 },
15695 "leaf" : 1,
15696 "path" : "/nodes/{node}/dns",
15697 "text" : "dns"
15698 },
15699 {
15700 "info" : {
15701 "GET" : {
15702 "allowtoken" : 1,
15703 "description" : "Read server time and time zone settings.",
15704 "method" : "GET",
15705 "name" : "time",
15706 "parameters" : {
15707 "additionalProperties" : 0,
15708 "properties" : {
15709 "node" : {
15710 "description" : "The cluster node name.",
15711 "format" : "pve-node",
15712 "type" : "string",
15713 "typetext" : "<string>"
15714 }
15715 }
15716 },
15717 "permissions" : {
15718 "check" : [
15719 "admin",
15720 "audit"
15721 ]
15722 },
15723 "proxyto" : "node",
15724 "returns" : {
15725 "additionalProperties" : 0,
15726 "properties" : {
15727 "localtime" : {
15728 "description" : "Seconds since 1970-01-01 00:00:00 (local time)",
15729 "minimum" : 1297163644,
15730 "type" : "integer"
15731 },
15732 "time" : {
15733 "description" : "Seconds since 1970-01-01 00:00:00 UTC.",
15734 "minimum" : 1297163644,
15735 "type" : "integer"
15736 },
15737 "timezone" : {
15738 "description" : "Time zone",
15739 "type" : "string"
15740 }
15741 },
15742 "type" : "object"
15743 }
15744 },
15745 "PUT" : {
15746 "allowtoken" : 1,
15747 "description" : "Set time zone.",
15748 "method" : "PUT",
15749 "name" : "set_timezone",
15750 "parameters" : {
15751 "additionalProperties" : 0,
15752 "properties" : {
15753 "node" : {
15754 "description" : "The cluster node name.",
15755 "format" : "pve-node",
15756 "type" : "string",
15757 "typetext" : "<string>"
15758 },
15759 "timezone" : {
15760 "description" : "Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.",
15761 "type" : "string",
15762 "typetext" : "<string>"
15763 }
15764 }
15765 },
15766 "protected" : 1,
15767 "proxyto" : "node",
15768 "returns" : {
15769 "type" : "null"
15770 }
15771 }
15772 },
15773 "leaf" : 1,
15774 "path" : "/nodes/{node}/time",
15775 "text" : "time"
15776 },
15777 {
15778 "info" : {
15779 "GET" : {
15780 "allowtoken" : 1,
15781 "description" : "Read server status. This is used by the cluster manager to test the node health.",
15782 "method" : "GET",
15783 "name" : "status",
15784 "parameters" : {
15785 "additionalProperties" : 0,
15786 "properties" : {
15787 "node" : {
15788 "description" : "The cluster node name.",
15789 "format" : "pve-node",
15790 "type" : "string",
15791 "typetext" : "<string>"
15792 }
15793 }
15794 },
15795 "permissions" : {
15796 "check" : [
15797 "admin",
15798 "qmanager",
15799 "audit"
15800 ]
15801 },
15802 "protected" : 1,
15803 "proxyto" : "node",
15804 "returns" : {
15805 "additionalProperties" : 1,
15806 "properties" : {
15807 "insync" : {
15808 "description" : "Database is synced with other nodes.",
15809 "type" : "boolean"
15810 },
15811 "time" : {
15812 "description" : "Seconds since 1970-01-01 00:00:00 UTC.",
15813 "minimum" : 1297163644,
15814 "type" : "integer"
15815 },
15816 "uptime" : {
15817 "description" : "The uptime of the system in seconds.",
15818 "minimum" : 0,
15819 "type" : "integer"
15820 }
15821 },
15822 "type" : "object"
15823 }
15824 },
15825 "POST" : {
15826 "allowtoken" : 1,
15827 "description" : "Reboot or shutdown a node.",
15828 "method" : "POST",
15829 "name" : "node_cmd",
15830 "parameters" : {
15831 "additionalProperties" : 0,
15832 "properties" : {
15833 "command" : {
15834 "description" : "Specify the command.",
15835 "enum" : [
15836 "reboot",
15837 "shutdown"
15838 ],
15839 "type" : "string"
15840 },
15841 "node" : {
15842 "description" : "The cluster node name.",
15843 "format" : "pve-node",
15844 "type" : "string",
15845 "typetext" : "<string>"
15846 }
15847 }
15848 },
15849 "permissions" : {
15850 "check" : [
15851 "admin"
15852 ]
15853 },
15854 "protected" : 1,
15855 "proxyto" : "node",
15856 "returns" : {
15857 "type" : "null"
15858 }
15859 }
15860 },
15861 "leaf" : 1,
15862 "path" : "/nodes/{node}/status",
15863 "text" : "status"
15864 }
15865 ],
15866 "info" : {
15867 "GET" : {
15868 "allowtoken" : 1,
15869 "description" : "Node index.",
15870 "method" : "GET",
15871 "name" : "index",
15872 "parameters" : {
15873 "additionalProperties" : 0,
15874 "properties" : {
15875 "node" : {
15876 "description" : "The cluster node name.",
15877 "format" : "pve-node",
15878 "type" : "string",
15879 "typetext" : "<string>"
15880 }
15881 }
15882 },
15883 "permissions" : {
15884 "user" : "all"
15885 },
15886 "returns" : {
15887 "items" : {
15888 "properties" : {},
15889 "type" : "object"
15890 },
15891 "links" : [
15892 {
15893 "href" : "{name}",
15894 "rel" : "child"
15895 }
15896 ],
15897 "type" : "array"
15898 }
15899 }
15900 },
15901 "leaf" : 0,
15902 "path" : "/nodes/{node}",
15903 "text" : "{node}"
15904 }
15905 ],
15906 "info" : {
15907 "GET" : {
15908 "allowtoken" : 1,
15909 "description" : "Cluster node index.",
15910 "method" : "GET",
15911 "name" : "index",
15912 "parameters" : {
15913 "additionalProperties" : 0
15914 },
15915 "permissions" : {
15916 "user" : "all"
15917 },
15918 "returns" : {
15919 "items" : {
15920 "properties" : {},
15921 "type" : "object"
15922 },
15923 "links" : [
15924 {
15925 "href" : "{node}",
15926 "rel" : "child"
15927 }
15928 ],
15929 "type" : "array"
15930 }
15931 }
15932 },
15933 "leaf" : 0,
15934 "path" : "/nodes",
15935 "text" : "nodes"
15936 },
15937 {
15938 "children" : [
15939 {
15940 "children" : [
15941 {
15942 "info" : {
15943 "DELETE" : {
15944 "allowtoken" : 1,
15945 "description" : "Delete a user.",
15946 "method" : "DELETE",
15947 "name" : "delete",
15948 "parameters" : {
15949 "additionalProperties" : 0,
15950 "properties" : {
15951 "userid" : {
15952 "description" : "User ID",
15953 "format" : "pmg-userid",
15954 "maxLength" : 64,
15955 "minLength" : 4,
15956 "type" : "string",
15957 "typetext" : "<string>"
15958 }
15959 }
15960 },
15961 "protected" : 1,
15962 "proxyto" : "master",
15963 "returns" : {
15964 "type" : "null"
15965 }
15966 },
15967 "GET" : {
15968 "allowtoken" : 1,
15969 "description" : "Read User data.",
15970 "method" : "GET",
15971 "name" : "read",
15972 "parameters" : {
15973 "additionalProperties" : 0,
15974 "properties" : {
15975 "userid" : {
15976 "description" : "User ID",
15977 "format" : "pmg-userid",
15978 "maxLength" : 64,
15979 "minLength" : 4,
15980 "type" : "string",
15981 "typetext" : "<string>"
15982 }
15983 }
15984 },
15985 "permissions" : {
15986 "check" : [
15987 "admin",
15988 "qmanager",
15989 "audit"
15990 ]
15991 },
15992 "protected" : 1,
15993 "proxyto" : "master",
15994 "returns" : {
15995 "type" : "object"
15996 }
15997 },
15998 "PUT" : {
15999 "allowtoken" : 1,
16000 "description" : "Update user data.",
16001 "method" : "PUT",
16002 "name" : "write",
16003 "parameters" : {
16004 "additionalProperties" : 0,
16005 "properties" : {
16006 "comment" : {
16007 "description" : "Comment.",
16008 "optional" : 1,
16009 "type" : "string",
16010 "typetext" : "<string>"
16011 },
16012 "crypt_pass" : {
16013 "description" : "Encrypted password (see `man crypt`)",
16014 "optional" : 1,
16015 "pattern" : "\\$\\d\\$[a-zA-Z0-9\\.\\/]+\\$[a-zA-Z0-9\\.\\/]+",
16016 "type" : "string"
16017 },
16018 "delete" : {
16019 "description" : "A list of settings you want to delete.",
16020 "format" : "pve-configid-list",
16021 "maxLength" : 4096,
16022 "optional" : 1,
16023 "type" : "string",
16024 "typetext" : "<string>"
16025 },
16026 "email" : {
16027 "description" : "Users E-Mail address.",
16028 "format" : "email",
16029 "optional" : 1,
16030 "type" : "string",
16031 "typetext" : "<string>"
16032 },
16033 "enable" : {
16034 "default" : 0,
16035 "description" : "Flag to enable or disable the account.",
16036 "optional" : 1,
16037 "type" : "boolean",
16038 "typetext" : "<boolean>"
16039 },
16040 "expire" : {
16041 "default" : 0,
16042 "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
16043 "minimum" : 0,
16044 "optional" : 1,
16045 "type" : "integer",
16046 "typetext" : "<integer> (0 - N)"
16047 },
16048 "firstname" : {
16049 "description" : "First name.",
16050 "maxLength" : 64,
16051 "optional" : 1,
16052 "type" : "string",
16053 "typetext" : "<string>"
16054 },
16055 "keys" : {
16056 "description" : "Keys for two factor auth (yubico).",
16057 "maxLength" : 128,
16058 "optional" : 1,
16059 "type" : "string",
16060 "typetext" : "<string>"
16061 },
16062 "lastname" : {
16063 "description" : "Last name.",
16064 "maxLength" : 64,
16065 "optional" : 1,
16066 "type" : "string",
16067 "typetext" : "<string>"
16068 },
16069 "password" : {
16070 "description" : "Password",
16071 "maxLength" : 32,
16072 "minLength" : 5,
16073 "optional" : 1,
16074 "type" : "string",
16075 "typetext" : "<string>"
16076 },
16077 "role" : {
16078 "description" : "User role. Role 'root' is reserved for the Unix Superuser.",
16079 "enum" : [
16080 "root",
16081 "admin",
16082 "helpdesk",
16083 "qmanager",
16084 "audit"
16085 ],
16086 "optional" : 1,
16087 "type" : "string"
16088 },
16089 "userid" : {
16090 "description" : "User ID",
16091 "format" : "pmg-userid",
16092 "maxLength" : 64,
16093 "minLength" : 4,
16094 "type" : "string",
16095 "typetext" : "<string>"
16096 }
16097 }
16098 },
16099 "protected" : 1,
16100 "proxyto" : "master",
16101 "returns" : {
16102 "type" : "null"
16103 }
16104 }
16105 },
16106 "leaf" : 1,
16107 "path" : "/access/users/{userid}",
16108 "text" : "{userid}"
16109 }
16110 ],
16111 "info" : {
16112 "GET" : {
16113 "allowtoken" : 1,
16114 "description" : "List users.",
16115 "method" : "GET",
16116 "name" : "index",
16117 "parameters" : {
16118 "additionalProperties" : 0
16119 },
16120 "permissions" : {
16121 "check" : [
16122 "admin",
16123 "qmanager",
16124 "audit"
16125 ]
16126 },
16127 "protected" : 1,
16128 "proxyto" : "master",
16129 "returns" : {
16130 "items" : {
16131 "properties" : {
16132 "comment" : {
16133 "optional" : 1,
16134 "type" : "string"
16135 },
16136 "enable" : {
16137 "type" : "boolean"
16138 },
16139 "role" : {
16140 "type" : "string"
16141 },
16142 "userid" : {
16143 "type" : "string"
16144 }
16145 },
16146 "type" : "object"
16147 },
16148 "links" : [
16149 {
16150 "href" : "{userid}",
16151 "rel" : "child"
16152 }
16153 ],
16154 "type" : "array"
16155 }
16156 },
16157 "POST" : {
16158 "allowtoken" : 1,
16159 "description" : "Create new user",
16160 "method" : "POST",
16161 "name" : "create",
16162 "parameters" : {
16163 "additionalProperties" : 0,
16164 "properties" : {
16165 "comment" : {
16166 "description" : "Comment.",
16167 "optional" : 1,
16168 "type" : "string",
16169 "typetext" : "<string>"
16170 },
16171 "crypt_pass" : {
16172 "description" : "Encrypted password (see `man crypt`)",
16173 "optional" : 1,
16174 "pattern" : "\\$\\d\\$[a-zA-Z0-9\\.\\/]+\\$[a-zA-Z0-9\\.\\/]+",
16175 "type" : "string"
16176 },
16177 "email" : {
16178 "description" : "Users E-Mail address.",
16179 "format" : "email",
16180 "optional" : 1,
16181 "type" : "string",
16182 "typetext" : "<string>"
16183 },
16184 "enable" : {
16185 "default" : 0,
16186 "description" : "Flag to enable or disable the account.",
16187 "optional" : 1,
16188 "type" : "boolean",
16189 "typetext" : "<boolean>"
16190 },
16191 "expire" : {
16192 "default" : 0,
16193 "description" : "Account expiration date (seconds since epoch). '0' means no expiration date.",
16194 "minimum" : 0,
16195 "optional" : 1,
16196 "type" : "integer",
16197 "typetext" : "<integer> (0 - N)"
16198 },
16199 "firstname" : {
16200 "description" : "First name.",
16201 "maxLength" : 64,
16202 "optional" : 1,
16203 "type" : "string",
16204 "typetext" : "<string>"
16205 },
16206 "keys" : {
16207 "description" : "Keys for two factor auth (yubico).",
16208 "maxLength" : 128,
16209 "optional" : 1,
16210 "type" : "string",
16211 "typetext" : "<string>"
16212 },
16213 "lastname" : {
16214 "description" : "Last name.",
16215 "maxLength" : 64,
16216 "optional" : 1,
16217 "type" : "string",
16218 "typetext" : "<string>"
16219 },
16220 "password" : {
16221 "description" : "Password",
16222 "maxLength" : 32,
16223 "minLength" : 5,
16224 "optional" : 1,
16225 "type" : "string",
16226 "typetext" : "<string>"
16227 },
16228 "role" : {
16229 "description" : "User role. Role 'root' is reserved for the Unix Superuser.",
16230 "enum" : [
16231 "root",
16232 "admin",
16233 "helpdesk",
16234 "qmanager",
16235 "audit"
16236 ],
16237 "type" : "string"
16238 },
16239 "userid" : {
16240 "description" : "User ID",
16241 "format" : "pmg-userid",
16242 "maxLength" : 64,
16243 "minLength" : 4,
16244 "type" : "string",
16245 "typetext" : "<string>"
16246 }
16247 }
16248 },
16249 "protected" : 1,
16250 "proxyto" : "master",
16251 "returns" : {
16252 "type" : "null"
16253 }
16254 }
16255 },
16256 "leaf" : 0,
16257 "path" : "/access/users",
16258 "text" : "users"
16259 },
16260 {
16261 "info" : {
16262 "GET" : {
16263 "allowtoken" : 1,
16264 "description" : "Dummy. Useful for formaters which want to priovde a login page.",
16265 "method" : "GET",
16266 "name" : "get_ticket",
16267 "parameters" : {
16268 "additionalProperties" : 0
16269 },
16270 "permissions" : {
16271 "user" : "world"
16272 },
16273 "returns" : {
16274 "type" : "null"
16275 }
16276 },
16277 "POST" : {
16278 "allowtoken" : 1,
16279 "description" : "Create or verify authentication ticket.",
16280 "method" : "POST",
16281 "name" : "create_ticket",
16282 "parameters" : {
16283 "additionalProperties" : 0,
16284 "properties" : {
16285 "otp" : {
16286 "description" : "One-time password for Two-factor authentication.",
16287 "optional" : 1,
16288 "type" : "string",
16289 "typetext" : "<string>"
16290 },
16291 "password" : {
16292 "description" : "The secret password. This can also be a valid ticket.",
16293 "type" : "string",
16294 "typetext" : "<string>"
16295 },
16296 "path" : {
16297 "description" : "Verify ticket, and check if user have access on 'path'",
16298 "maxLength" : 64,
16299 "optional" : 1,
16300 "type" : "string",
16301 "typetext" : "<string>"
16302 },
16303 "realm" : {
16304 "description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.",
16305 "enum" : [
16306 "pam",
16307 "pmg",
16308 "quarantine"
16309 ],
16310 "maxLength" : 32,
16311 "optional" : 1,
16312 "type" : "string"
16313 },
16314 "username" : {
16315 "description" : "User name",
16316 "maxLength" : 64,
16317 "type" : "string",
16318 "typetext" : "<string>"
16319 }
16320 }
16321 },
16322 "permissions" : {
16323 "description" : "You need to pass valid credientials.",
16324 "user" : "world"
16325 },
16326 "protected" : 1,
16327 "returns" : {
16328 "properties" : {
16329 "CSRFPreventionToken" : {
16330 "optional" : 1,
16331 "type" : "string"
16332 },
16333 "role" : {
16334 "optional" : 1,
16335 "type" : "string"
16336 },
16337 "ticket" : {
16338 "optional" : 1,
16339 "type" : "string"
16340 },
16341 "username" : {
16342 "type" : "string"
16343 }
16344 },
16345 "type" : "object"
16346 }
16347 }
16348 },
16349 "leaf" : 1,
16350 "path" : "/access/ticket",
16351 "text" : "ticket"
16352 },
16353 {
16354 "info" : {
16355 "PUT" : {
16356 "allowtoken" : 1,
16357 "description" : "Change user password.",
16358 "method" : "PUT",
16359 "name" : "change_passsword",
16360 "parameters" : {
16361 "additionalProperties" : 0,
16362 "properties" : {
16363 "password" : {
16364 "description" : "The new password.",
16365 "maxLength" : 64,
16366 "minLength" : 5,
16367 "type" : "string",
16368 "typetext" : "<string>"
16369 },
16370 "userid" : {
16371 "description" : "User ID",
16372 "format" : "pmg-userid",
16373 "maxLength" : 64,
16374 "minLength" : 4,
16375 "type" : "string",
16376 "typetext" : "<string>"
16377 }
16378 }
16379 },
16380 "permissions" : {
16381 "description" : "Each user is allowed to change his own password. Only root can change the password of another user.",
16382 "user" : "all"
16383 },
16384 "protected" : 1,
16385 "returns" : {
16386 "type" : "null"
16387 }
16388 }
16389 },
16390 "leaf" : 1,
16391 "path" : "/access/password",
16392 "text" : "password"
16393 }
16394 ],
16395 "info" : {
16396 "GET" : {
16397 "allowtoken" : 1,
16398 "description" : "Directory index.",
16399 "method" : "GET",
16400 "name" : "index",
16401 "parameters" : {
16402 "additionalProperties" : 0
16403 },
16404 "permissions" : {
16405 "user" : "all"
16406 },
16407 "returns" : {
16408 "items" : {
16409 "properties" : {
16410 "subdir" : {
16411 "type" : "string"
16412 }
16413 },
16414 "type" : "object"
16415 },
16416 "links" : [
16417 {
16418 "href" : "{subdir}",
16419 "rel" : "child"
16420 }
16421 ],
16422 "type" : "array"
16423 }
16424 }
16425 },
16426 "leaf" : 0,
16427 "path" : "/access",
16428 "text" : "access"
16429 },
16430 {
16431 "children" : [
16432 {
16433 "info" : {
16434 "DELETE" : {
16435 "allowtoken" : 1,
16436 "description" : "Delete user whitelist entries.",
16437 "method" : "DELETE",
16438 "name" : "whitelist_delete_base",
16439 "parameters" : {
16440 "additionalProperties" : 0,
16441 "properties" : {
16442 "address" : {
16443 "description" : "The address, or comma-separated list of addresses, you want to remove.",
16444 "minLength" : 3,
16445 "pattern" : "",
16446 "type" : "string"
16447 },
16448 "pmail" : {
16449 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16450 "maxLength" : 512,
16451 "minLength" : 3,
16452 "optional" : 1,
16453 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16454 "type" : "string"
16455 }
16456 }
16457 },
16458 "permissions" : {
16459 "check" : [
16460 "admin",
16461 "qmanager",
16462 "audit",
16463 "quser"
16464 ]
16465 },
16466 "protected" : 1,
16467 "returns" : {
16468 "type" : "null"
16469 }
16470 },
16471 "GET" : {
16472 "allowtoken" : 1,
16473 "description" : "Show user whitelist.",
16474 "method" : "GET",
16475 "name" : "whitelist",
16476 "parameters" : {
16477 "additionalProperties" : 0,
16478 "properties" : {
16479 "pmail" : {
16480 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16481 "maxLength" : 512,
16482 "minLength" : 3,
16483 "optional" : 1,
16484 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16485 "type" : "string"
16486 }
16487 }
16488 },
16489 "permissions" : {
16490 "check" : [
16491 "admin",
16492 "qmanager",
16493 "audit",
16494 "quser"
16495 ]
16496 },
16497 "returns" : {
16498 "items" : {
16499 "properties" : {
16500 "address" : {
16501 "type" : "string"
16502 }
16503 },
16504 "type" : "object"
16505 },
16506 "type" : "array"
16507 }
16508 },
16509 "POST" : {
16510 "allowtoken" : 1,
16511 "description" : "Add user whitelist entries.",
16512 "method" : "POST",
16513 "name" : "whitelist_add",
16514 "parameters" : {
16515 "additionalProperties" : 0,
16516 "properties" : {
16517 "address" : {
16518 "description" : "The address you want to add.",
16519 "minLength" : 3,
16520 "pattern" : "(?:[^\\s\\/\\\\;\\,]+)(?:\\,[^\\s\\/\\\\;\\,]+)*",
16521 "type" : "string"
16522 },
16523 "pmail" : {
16524 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16525 "maxLength" : 512,
16526 "minLength" : 3,
16527 "optional" : 1,
16528 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16529 "type" : "string"
16530 }
16531 }
16532 },
16533 "permissions" : {
16534 "check" : [
16535 "admin",
16536 "qmanager",
16537 "audit",
16538 "quser"
16539 ]
16540 },
16541 "protected" : 1,
16542 "returns" : {
16543 "type" : "null"
16544 }
16545 }
16546 },
16547 "leaf" : 1,
16548 "path" : "/quarantine/whitelist",
16549 "text" : "whitelist"
16550 },
16551 {
16552 "info" : {
16553 "DELETE" : {
16554 "allowtoken" : 1,
16555 "description" : "Delete user blacklist entries.",
16556 "method" : "DELETE",
16557 "name" : "blacklist_delete_base",
16558 "parameters" : {
16559 "additionalProperties" : 0,
16560 "properties" : {
16561 "address" : {
16562 "description" : "The address, or comma-separated list of addresses, you want to remove.",
16563 "minLength" : 3,
16564 "pattern" : "",
16565 "type" : "string"
16566 },
16567 "pmail" : {
16568 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16569 "maxLength" : 512,
16570 "minLength" : 3,
16571 "optional" : 1,
16572 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16573 "type" : "string"
16574 }
16575 }
16576 },
16577 "permissions" : {
16578 "check" : [
16579 "admin",
16580 "qmanager",
16581 "audit",
16582 "quser"
16583 ]
16584 },
16585 "protected" : 1,
16586 "returns" : {
16587 "type" : "null"
16588 }
16589 },
16590 "GET" : {
16591 "allowtoken" : 1,
16592 "description" : "Show user blacklist.",
16593 "method" : "GET",
16594 "name" : "blacklist",
16595 "parameters" : {
16596 "additionalProperties" : 0,
16597 "properties" : {
16598 "pmail" : {
16599 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16600 "maxLength" : 512,
16601 "minLength" : 3,
16602 "optional" : 1,
16603 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16604 "type" : "string"
16605 }
16606 }
16607 },
16608 "permissions" : {
16609 "check" : [
16610 "admin",
16611 "qmanager",
16612 "audit",
16613 "quser"
16614 ]
16615 },
16616 "returns" : {
16617 "items" : {
16618 "properties" : {
16619 "address" : {
16620 "type" : "string"
16621 }
16622 },
16623 "type" : "object"
16624 },
16625 "type" : "array"
16626 }
16627 },
16628 "POST" : {
16629 "allowtoken" : 1,
16630 "description" : "Add user blacklist entries.",
16631 "method" : "POST",
16632 "name" : "blacklist_add",
16633 "parameters" : {
16634 "additionalProperties" : 0,
16635 "properties" : {
16636 "address" : {
16637 "description" : "The address you want to add.",
16638 "minLength" : 3,
16639 "pattern" : "(?:[^\\s\\/\\\\;\\,]+)(?:\\,[^\\s\\/\\\\;\\,]+)*",
16640 "type" : "string"
16641 },
16642 "pmail" : {
16643 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16644 "maxLength" : 512,
16645 "minLength" : 3,
16646 "optional" : 1,
16647 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16648 "type" : "string"
16649 }
16650 }
16651 },
16652 "permissions" : {
16653 "check" : [
16654 "admin",
16655 "qmanager",
16656 "audit",
16657 "quser"
16658 ]
16659 },
16660 "protected" : 1,
16661 "returns" : {
16662 "type" : "null"
16663 }
16664 }
16665 },
16666 "leaf" : 1,
16667 "path" : "/quarantine/blacklist",
16668 "text" : "blacklist"
16669 },
16670 {
16671 "info" : {
16672 "GET" : {
16673 "allowtoken" : 1,
16674 "description" : "Get a list of receivers of spam in the given timespan (Default the last 24 hours).",
16675 "method" : "GET",
16676 "name" : "spamusers",
16677 "parameters" : {
16678 "additionalProperties" : 0,
16679 "properties" : {
16680 "endtime" : {
16681 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
16682 "minimum" : 1,
16683 "optional" : 1,
16684 "type" : "integer",
16685 "typetext" : "<integer> (1 - N)"
16686 },
16687 "starttime" : {
16688 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
16689 "minimum" : 0,
16690 "optional" : 1,
16691 "type" : "integer",
16692 "typetext" : "<integer> (0 - N)"
16693 }
16694 }
16695 },
16696 "permissions" : {
16697 "check" : [
16698 "admin",
16699 "qmanager",
16700 "audit"
16701 ]
16702 },
16703 "returns" : {
16704 "items" : {
16705 "properties" : {
16706 "mail" : {
16707 "description" : "the receiving email",
16708 "type" : "string"
16709 }
16710 },
16711 "type" : "object"
16712 },
16713 "type" : "array"
16714 }
16715 }
16716 },
16717 "leaf" : 1,
16718 "path" : "/quarantine/spamusers",
16719 "text" : "spamusers"
16720 },
16721 {
16722 "info" : {
16723 "GET" : {
16724 "allowtoken" : 1,
16725 "description" : "Get Spam Quarantine Status",
16726 "method" : "GET",
16727 "name" : "spamstatus",
16728 "parameters" : {
16729 "additionalProperties" : 0
16730 },
16731 "permissions" : {
16732 "check" : [
16733 "admin",
16734 "qmanager",
16735 "audit"
16736 ]
16737 },
16738 "returns" : {
16739 "properties" : {
16740 "avgbytes" : {
16741 "description" : "Average size of stored mails in bytes.",
16742 "type" : "number"
16743 },
16744 "avgspam" : {
16745 "description" : "Average spam level.",
16746 "type" : "number"
16747 },
16748 "count" : {
16749 "description" : "Number of stored mails.",
16750 "type" : "integer"
16751 },
16752 "mbytes" : {
16753 "description" : "Estimated disk space usage in MByte.",
16754 "type" : "number"
16755 }
16756 },
16757 "type" : "object"
16758 }
16759 }
16760 },
16761 "leaf" : 1,
16762 "path" : "/quarantine/spamstatus",
16763 "text" : "spamstatus"
16764 },
16765 {
16766 "info" : {
16767 "GET" : {
16768 "allowtoken" : 1,
16769 "description" : "Get a list of users with whitelist/blacklist settings.",
16770 "method" : "GET",
16771 "name" : "quarusers",
16772 "parameters" : {
16773 "additionalProperties" : 0,
16774 "properties" : {
16775 "list" : {
16776 "description" : "If set, limits the result to the given list.",
16777 "enum" : [
16778 "BL",
16779 "WL"
16780 ],
16781 "optional" : 1,
16782 "type" : "string"
16783 }
16784 }
16785 },
16786 "permissions" : {
16787 "check" : [
16788 "admin",
16789 "qmanager",
16790 "audit"
16791 ]
16792 },
16793 "returns" : {
16794 "items" : {
16795 "properties" : {
16796 "mail" : {
16797 "description" : "the receiving email",
16798 "type" : "string"
16799 }
16800 },
16801 "type" : "object"
16802 },
16803 "type" : "array"
16804 }
16805 }
16806 },
16807 "leaf" : 1,
16808 "path" : "/quarantine/quarusers",
16809 "text" : "quarusers"
16810 },
16811 {
16812 "info" : {
16813 "GET" : {
16814 "allowtoken" : 1,
16815 "description" : "Get a list of quarantined spam mails in the given timeframe (default the last 24 hours) for the given user.",
16816 "method" : "GET",
16817 "name" : "spam",
16818 "parameters" : {
16819 "additionalProperties" : 0,
16820 "properties" : {
16821 "endtime" : {
16822 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
16823 "minimum" : 1,
16824 "optional" : 1,
16825 "type" : "integer",
16826 "typetext" : "<integer> (1 - N)"
16827 },
16828 "pmail" : {
16829 "description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
16830 "maxLength" : 512,
16831 "minLength" : 3,
16832 "optional" : 1,
16833 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
16834 "type" : "string"
16835 },
16836 "starttime" : {
16837 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
16838 "minimum" : 0,
16839 "optional" : 1,
16840 "type" : "integer",
16841 "typetext" : "<integer> (0 - N)"
16842 }
16843 }
16844 },
16845 "permissions" : {
16846 "check" : [
16847 "admin",
16848 "qmanager",
16849 "audit",
16850 "quser"
16851 ]
16852 },
16853 "returns" : {
16854 "items" : {
16855 "properties" : {
16856 "bytes" : {
16857 "description" : "Size of raw email.",
16858 "type" : "integer"
16859 },
16860 "envelope_sender" : {
16861 "description" : "SMTP envelope sender.",
16862 "type" : "string"
16863 },
16864 "from" : {
16865 "description" : "Header 'From' field.",
16866 "type" : "string"
16867 },
16868 "id" : {
16869 "description" : "Unique ID",
16870 "type" : "string"
16871 },
16872 "receiver" : {
16873 "description" : "Receiver email address",
16874 "type" : "string"
16875 },
16876 "sender" : {
16877 "description" : "Header 'Sender' field.",
16878 "optional" : 1,
16879 "type" : "string"
16880 },
16881 "spamlevel" : {
16882 "description" : "Spam score.",
16883 "type" : "number"
16884 },
16885 "subject" : {
16886 "description" : "Header 'Subject' field.",
16887 "type" : "string"
16888 },
16889 "time" : {
16890 "description" : "Receive time stamp",
16891 "type" : "integer"
16892 }
16893 },
16894 "type" : "object"
16895 },
16896 "type" : "array"
16897 }
16898 }
16899 },
16900 "leaf" : 1,
16901 "path" : "/quarantine/spam",
16902 "text" : "spam"
16903 },
16904 {
16905 "info" : {
16906 "GET" : {
16907 "allowtoken" : 1,
16908 "description" : "Get a list of quarantined virus mails in the given timeframe (default the last 24 hours).",
16909 "method" : "GET",
16910 "name" : "virus",
16911 "parameters" : {
16912 "additionalProperties" : 0,
16913 "properties" : {
16914 "endtime" : {
16915 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
16916 "minimum" : 1,
16917 "optional" : 1,
16918 "type" : "integer",
16919 "typetext" : "<integer> (1 - N)"
16920 },
16921 "starttime" : {
16922 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
16923 "minimum" : 0,
16924 "optional" : 1,
16925 "type" : "integer",
16926 "typetext" : "<integer> (0 - N)"
16927 }
16928 }
16929 },
16930 "permissions" : {
16931 "check" : [
16932 "admin",
16933 "qmanager",
16934 "audit"
16935 ]
16936 },
16937 "returns" : {
16938 "items" : {
16939 "properties" : {
16940 "bytes" : {
16941 "description" : "Size of raw email.",
16942 "type" : "integer"
16943 },
16944 "envelope_sender" : {
16945 "description" : "SMTP envelope sender.",
16946 "type" : "string"
16947 },
16948 "from" : {
16949 "description" : "Header 'From' field.",
16950 "type" : "string"
16951 },
16952 "id" : {
16953 "description" : "Unique ID",
16954 "type" : "string"
16955 },
16956 "receiver" : {
16957 "description" : "Receiver email address",
16958 "type" : "string"
16959 },
16960 "sender" : {
16961 "description" : "Header 'Sender' field.",
16962 "optional" : 1,
16963 "type" : "string"
16964 },
16965 "subject" : {
16966 "description" : "Header 'Subject' field.",
16967 "type" : "string"
16968 },
16969 "time" : {
16970 "description" : "Receive time stamp",
16971 "type" : "integer"
16972 },
16973 "virusname" : {
16974 "description" : "Virus name.",
16975 "type" : "string"
16976 }
16977 },
16978 "type" : "object"
16979 },
16980 "type" : "array"
16981 }
16982 }
16983 },
16984 "leaf" : 1,
16985 "path" : "/quarantine/virus",
16986 "text" : "virus"
16987 },
16988 {
16989 "info" : {
16990 "GET" : {
16991 "allowtoken" : 1,
16992 "description" : "Get a list of quarantined attachment mails in the given timeframe (default the last 24 hours).",
16993 "method" : "GET",
16994 "name" : "attachment",
16995 "parameters" : {
16996 "additionalProperties" : 0,
16997 "properties" : {
16998 "endtime" : {
16999 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17000 "minimum" : 1,
17001 "optional" : 1,
17002 "type" : "integer",
17003 "typetext" : "<integer> (1 - N)"
17004 },
17005 "starttime" : {
17006 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
17007 "minimum" : 0,
17008 "optional" : 1,
17009 "type" : "integer",
17010 "typetext" : "<integer> (0 - N)"
17011 }
17012 }
17013 },
17014 "permissions" : {
17015 "check" : [
17016 "admin",
17017 "qmanager",
17018 "audit"
17019 ]
17020 },
17021 "returns" : {
17022 "items" : {
17023 "properties" : {
17024 "bytes" : {
17025 "description" : "Size of raw email.",
17026 "type" : "integer"
17027 },
17028 "envelope_sender" : {
17029 "description" : "SMTP envelope sender.",
17030 "type" : "string"
17031 },
17032 "from" : {
17033 "description" : "Header 'From' field.",
17034 "type" : "string"
17035 },
17036 "id" : {
17037 "description" : "Unique ID",
17038 "type" : "string"
17039 },
17040 "receiver" : {
17041 "description" : "Receiver email address",
17042 "type" : "string"
17043 },
17044 "sender" : {
17045 "description" : "Header 'Sender' field.",
17046 "optional" : 1,
17047 "type" : "string"
17048 },
17049 "subject" : {
17050 "description" : "Header 'Subject' field.",
17051 "type" : "string"
17052 },
17053 "time" : {
17054 "description" : "Receive time stamp",
17055 "type" : "integer"
17056 }
17057 },
17058 "type" : "object"
17059 },
17060 "type" : "array"
17061 }
17062 }
17063 },
17064 "leaf" : 1,
17065 "path" : "/quarantine/attachment",
17066 "text" : "attachment"
17067 },
17068 {
17069 "info" : {
17070 "GET" : {
17071 "allowtoken" : 1,
17072 "description" : "Get Virus Quarantine Status",
17073 "method" : "GET",
17074 "name" : "virusstatus",
17075 "parameters" : {
17076 "additionalProperties" : 0
17077 },
17078 "permissions" : {
17079 "check" : [
17080 "admin",
17081 "qmanager",
17082 "audit"
17083 ]
17084 },
17085 "returns" : {
17086 "properties" : {
17087 "avgbytes" : {
17088 "description" : "Average size of stored mails in bytes.",
17089 "type" : "number"
17090 },
17091 "count" : {
17092 "description" : "Number of stored mails.",
17093 "type" : "integer"
17094 },
17095 "mbytes" : {
17096 "description" : "Estimated disk space usage in MByte.",
17097 "type" : "number"
17098 }
17099 },
17100 "type" : "object"
17101 }
17102 }
17103 },
17104 "leaf" : 1,
17105 "path" : "/quarantine/virusstatus",
17106 "text" : "virusstatus"
17107 },
17108 {
17109 "info" : {
17110 "GET" : {
17111 "allowtoken" : 1,
17112 "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).",
17113 "method" : "GET",
17114 "name" : "content",
17115 "parameters" : {
17116 "additionalProperties" : 0,
17117 "properties" : {
17118 "id" : {
17119 "description" : "Unique ID",
17120 "maxLength" : 60,
17121 "pattern" : "C\\d+R\\d+T\\d+",
17122 "type" : "string"
17123 },
17124 "raw" : {
17125 "default" : 0,
17126 "description" : "Display 'raw' eml data. Deactivates size limit.",
17127 "optional" : 1,
17128 "type" : "boolean",
17129 "typetext" : "<boolean>"
17130 }
17131 }
17132 },
17133 "permissions" : {
17134 "check" : [
17135 "admin",
17136 "qmanager",
17137 "audit",
17138 "quser"
17139 ]
17140 },
17141 "returns" : {
17142 "properties" : {
17143 "bytes" : {
17144 "description" : "Size of raw email.",
17145 "type" : "integer"
17146 },
17147 "content" : {
17148 "description" : "Raw email data (first 4096 bytes). Useful for preview. NOTE: The 'htmlmail' formatter displays the whole email.",
17149 "type" : "string"
17150 },
17151 "envelope_sender" : {
17152 "description" : "SMTP envelope sender.",
17153 "type" : "string"
17154 },
17155 "from" : {
17156 "description" : "Header 'From' field.",
17157 "type" : "string"
17158 },
17159 "header" : {
17160 "description" : "Raw email header data.",
17161 "type" : "string"
17162 },
17163 "id" : {
17164 "description" : "Unique ID",
17165 "type" : "string"
17166 },
17167 "receiver" : {
17168 "description" : "Receiver email address",
17169 "type" : "string"
17170 },
17171 "sender" : {
17172 "description" : "Header 'Sender' field.",
17173 "optional" : 1,
17174 "type" : "string"
17175 },
17176 "spaminfo" : {
17177 "description" : "Information about matched spam tests (name, score, desc, url).",
17178 "type" : "array"
17179 },
17180 "spamlevel" : {
17181 "description" : "Spam score.",
17182 "type" : "number"
17183 },
17184 "subject" : {
17185 "description" : "Header 'Subject' field.",
17186 "type" : "string"
17187 },
17188 "time" : {
17189 "description" : "Receive time stamp",
17190 "type" : "integer"
17191 }
17192 },
17193 "type" : "object"
17194 }
17195 },
17196 "POST" : {
17197 "allowtoken" : 1,
17198 "description" : "Execute quarantine actions.",
17199 "method" : "POST",
17200 "name" : "action",
17201 "parameters" : {
17202 "additionalProperties" : 0,
17203 "properties" : {
17204 "action" : {
17205 "description" : "Action - specify what you want to do with the mail.",
17206 "enum" : [
17207 "whitelist",
17208 "blacklist",
17209 "deliver",
17210 "delete"
17211 ],
17212 "type" : "string"
17213 },
17214 "id" : {
17215 "description" : "Unique IDs, separate with ;",
17216 "pattern" : "C\\d+R\\d+T\\d+(;C\\d+R\\d+T\\d+)*",
17217 "type" : "string"
17218 }
17219 }
17220 },
17221 "permissions" : {
17222 "check" : [
17223 "admin",
17224 "qmanager",
17225 "quser"
17226 ]
17227 },
17228 "protected" : 1,
17229 "returns" : {
17230 "type" : "null"
17231 }
17232 }
17233 },
17234 "leaf" : 1,
17235 "path" : "/quarantine/content",
17236 "text" : "content"
17237 },
17238 {
17239 "info" : {
17240 "GET" : {
17241 "allowtoken" : 1,
17242 "description" : "Get Attachments for E-Mail in Quarantine.",
17243 "method" : "GET",
17244 "name" : "listattachments",
17245 "parameters" : {
17246 "additionalProperties" : 0,
17247 "properties" : {
17248 "id" : {
17249 "description" : "Unique ID",
17250 "maxLength" : 60,
17251 "pattern" : "C\\d+R\\d+T\\d+",
17252 "type" : "string"
17253 }
17254 }
17255 },
17256 "permissions" : {
17257 "check" : [
17258 "admin",
17259 "qmanager",
17260 "audit"
17261 ]
17262 },
17263 "returns" : {
17264 "items" : {
17265 "properties" : {
17266 "content-type" : {
17267 "description" : "Raw email header data.",
17268 "type" : "string"
17269 },
17270 "id" : {
17271 "description" : "Attachment ID",
17272 "type" : "integer"
17273 },
17274 "name" : {
17275 "description" : "Raw email header data.",
17276 "type" : "string"
17277 },
17278 "size" : {
17279 "description" : "Size of raw attachment in bytes.",
17280 "type" : "integer"
17281 }
17282 },
17283 "type" : "object"
17284 },
17285 "type" : "array"
17286 }
17287 }
17288 },
17289 "leaf" : 1,
17290 "path" : "/quarantine/listattachments",
17291 "text" : "listattachments"
17292 },
17293 {
17294 "info" : {
17295 "GET" : {
17296 "allowtoken" : 1,
17297 "description" : "Download E-Mail or Attachment from Quarantine.",
17298 "download" : 1,
17299 "method" : "GET",
17300 "name" : "download",
17301 "parameters" : {
17302 "additionalProperties" : 0,
17303 "properties" : {
17304 "attachmentid" : {
17305 "description" : "The Attachment ID for the mail.",
17306 "optional" : 1,
17307 "type" : "integer",
17308 "typetext" : "<integer>"
17309 },
17310 "mailid" : {
17311 "description" : "Unique ID",
17312 "maxLength" : 60,
17313 "pattern" : "C\\d+R\\d+T\\d+",
17314 "type" : "string"
17315 }
17316 }
17317 },
17318 "permissions" : {
17319 "check" : [
17320 "admin",
17321 "qmanager",
17322 "audit",
17323 "quser"
17324 ]
17325 },
17326 "returns" : {
17327 "type" : "object"
17328 }
17329 }
17330 },
17331 "leaf" : 1,
17332 "path" : "/quarantine/download",
17333 "text" : "download"
17334 },
17335 {
17336 "info" : {
17337 "POST" : {
17338 "allowtoken" : 1,
17339 "description" : "Send Quarantine link to given e-mail.",
17340 "method" : "POST",
17341 "name" : "sendlink",
17342 "parameters" : {
17343 "additionalProperties" : 0,
17344 "properties" : {
17345 "mail" : {
17346 "description" : "Email Address (allow most characters).",
17347 "maxLength" : 512,
17348 "minLength" : 3,
17349 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
17350 "type" : "string"
17351 }
17352 }
17353 },
17354 "permissions" : {
17355 "user" : "world"
17356 },
17357 "protected" : 1,
17358 "returns" : {
17359 "type" : "null"
17360 }
17361 }
17362 },
17363 "leaf" : 1,
17364 "path" : "/quarantine/sendlink",
17365 "text" : "sendlink"
17366 }
17367 ],
17368 "info" : {
17369 "GET" : {
17370 "allowtoken" : 1,
17371 "description" : "Directory index.",
17372 "method" : "GET",
17373 "name" : "index",
17374 "parameters" : {
17375 "additionalProperties" : 0
17376 },
17377 "permissions" : {
17378 "user" : "all"
17379 },
17380 "returns" : {
17381 "items" : {
17382 "properties" : {},
17383 "type" : "object"
17384 },
17385 "links" : [
17386 {
17387 "href" : "{name}",
17388 "rel" : "child"
17389 }
17390 ],
17391 "type" : "array"
17392 }
17393 }
17394 },
17395 "leaf" : 0,
17396 "path" : "/quarantine",
17397 "text" : "quarantine"
17398 },
17399 {
17400 "children" : [
17401 {
17402 "info" : {
17403 "GET" : {
17404 "allowtoken" : 1,
17405 "description" : "Contact Address Statistics.",
17406 "method" : "GET",
17407 "name" : "contact",
17408 "parameters" : {
17409 "additionalProperties" : 0,
17410 "properties" : {
17411 "day" : {
17412 "description" : "Day of month. Get statistics for a single day.",
17413 "maximum" : 31,
17414 "minimum" : 1,
17415 "optional" : 1,
17416 "type" : "integer",
17417 "typetext" : "<integer> (1 - 31)"
17418 },
17419 "endtime" : {
17420 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17421 "minimum" : 1,
17422 "optional" : 1,
17423 "type" : "integer",
17424 "typetext" : "<integer> (1 - N)"
17425 },
17426 "filter" : {
17427 "description" : "Contact address filter.",
17428 "maxLength" : 512,
17429 "optional" : 1,
17430 "type" : "string",
17431 "typetext" : "<string>"
17432 },
17433 "month" : {
17434 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
17435 "maximum" : 12,
17436 "minimum" : 1,
17437 "optional" : 1,
17438 "type" : "integer",
17439 "typetext" : "<integer> (1 - 12)"
17440 },
17441 "orderby" : {
17442 "description" : "Remote sorting configuration(JSON, ExtJS compatible).",
17443 "maxLength" : 4096,
17444 "optional" : 1,
17445 "type" : "string",
17446 "typetext" : "<string>"
17447 },
17448 "starttime" : {
17449 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
17450 "minimum" : 0,
17451 "optional" : 1,
17452 "type" : "integer",
17453 "typetext" : "<integer> (0 - N)"
17454 },
17455 "year" : {
17456 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
17457 "maximum" : 3000,
17458 "minimum" : 1900,
17459 "optional" : 1,
17460 "type" : "integer",
17461 "typetext" : "<integer> (1900 - 3000)"
17462 }
17463 }
17464 },
17465 "permissions" : {
17466 "check" : [
17467 "admin",
17468 "qmanager",
17469 "audit"
17470 ]
17471 },
17472 "returns" : {
17473 "items" : {
17474 "properties" : {
17475 "bytes" : {
17476 "description" : "Mail traffic (Bytes).",
17477 "type" : "number"
17478 },
17479 "contact" : {
17480 "description" : "Contact email.",
17481 "type" : "string"
17482 },
17483 "count" : {
17484 "description" : "Mail count.",
17485 "optional" : 1,
17486 "type" : "number"
17487 },
17488 "viruscount" : {
17489 "description" : "Number of sent virus mails.",
17490 "optional" : 1,
17491 "type" : "number"
17492 }
17493 },
17494 "type" : "object"
17495 },
17496 "links" : [
17497 {
17498 "href" : "{contact}",
17499 "rel" : "child"
17500 }
17501 ],
17502 "type" : "array"
17503 }
17504 }
17505 },
17506 "leaf" : 1,
17507 "path" : "/statistics/contact",
17508 "text" : "contact"
17509 },
17510 {
17511 "info" : {
17512 "GET" : {
17513 "allowtoken" : 1,
17514 "description" : "Detailed Statistics.",
17515 "method" : "GET",
17516 "name" : "detailstats",
17517 "parameters" : {
17518 "additionalProperties" : 0,
17519 "properties" : {
17520 "address" : {
17521 "description" : "Email address.",
17522 "maxLength" : 512,
17523 "minLength" : 3,
17524 "pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
17525 "type" : "string"
17526 },
17527 "day" : {
17528 "description" : "Day of month. Get statistics for a single day.",
17529 "maximum" : 31,
17530 "minimum" : 1,
17531 "optional" : 1,
17532 "type" : "integer",
17533 "typetext" : "<integer> (1 - 31)"
17534 },
17535 "endtime" : {
17536 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17537 "minimum" : 1,
17538 "optional" : 1,
17539 "type" : "integer",
17540 "typetext" : "<integer> (1 - N)"
17541 },
17542 "filter" : {
17543 "description" : "Address filter.",
17544 "maxLength" : 512,
17545 "optional" : 1,
17546 "type" : "string",
17547 "typetext" : "<string>"
17548 },
17549 "month" : {
17550 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
17551 "maximum" : 12,
17552 "minimum" : 1,
17553 "optional" : 1,
17554 "type" : "integer",
17555 "typetext" : "<integer> (1 - 12)"
17556 },
17557 "orderby" : {
17558 "description" : "Remote sorting configuration(JSON, ExtJS compatible).",
17559 "maxLength" : 4096,
17560 "optional" : 1,
17561 "type" : "string",
17562 "typetext" : "<string>"
17563 },
17564 "starttime" : {
17565 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
17566 "minimum" : 0,
17567 "optional" : 1,
17568 "type" : "integer",
17569 "typetext" : "<integer> (0 - N)"
17570 },
17571 "type" : {
17572 "description" : "Type of statistics",
17573 "enum" : [
17574 "contact",
17575 "sender",
17576 "receiver"
17577 ],
17578 "type" : "string"
17579 },
17580 "year" : {
17581 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
17582 "maximum" : 3000,
17583 "minimum" : 1900,
17584 "optional" : 1,
17585 "type" : "integer",
17586 "typetext" : "<integer> (1900 - 3000)"
17587 }
17588 }
17589 },
17590 "permissions" : {
17591 "check" : [
17592 "admin",
17593 "qmanager",
17594 "audit"
17595 ]
17596 },
17597 "returns" : {
17598 "items" : {
17599 "properties" : {
17600 "blocked" : {
17601 "description" : "Mail was blocked.",
17602 "type" : "boolean"
17603 },
17604 "bytes" : {
17605 "description" : "Mail traffic (Bytes).",
17606 "type" : "number"
17607 },
17608 "receiver" : {
17609 "description" : "Receiver email. (for sender statistics)",
17610 "optional" : 1,
17611 "type" : "string"
17612 },
17613 "sender" : {
17614 "description" : "Sender email. (for contact and receiver statistics)",
17615 "optional" : 1,
17616 "type" : "string"
17617 },
17618 "spamlevel" : {
17619 "description" : "Spam score.",
17620 "type" : "number"
17621 },
17622 "time" : {
17623 "description" : "Receive time stamp",
17624 "type" : "integer"
17625 },
17626 "virusinfo" : {
17627 "description" : "Virus name.",
17628 "optional" : 1,
17629 "type" : "string"
17630 }
17631 },
17632 "type" : "object"
17633 },
17634 "type" : "array"
17635 }
17636 }
17637 },
17638 "leaf" : 1,
17639 "path" : "/statistics/detail",
17640 "text" : "detail"
17641 },
17642 {
17643 "info" : {
17644 "GET" : {
17645 "allowtoken" : 1,
17646 "description" : "Sender Address Statistics.",
17647 "method" : "GET",
17648 "name" : "sender",
17649 "parameters" : {
17650 "additionalProperties" : 0,
17651 "properties" : {
17652 "day" : {
17653 "description" : "Day of month. Get statistics for a single day.",
17654 "maximum" : 31,
17655 "minimum" : 1,
17656 "optional" : 1,
17657 "type" : "integer",
17658 "typetext" : "<integer> (1 - 31)"
17659 },
17660 "endtime" : {
17661 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17662 "minimum" : 1,
17663 "optional" : 1,
17664 "type" : "integer",
17665 "typetext" : "<integer> (1 - N)"
17666 },
17667 "filter" : {
17668 "description" : "Sender address filter.",
17669 "maxLength" : 512,
17670 "optional" : 1,
17671 "type" : "string",
17672 "typetext" : "<string>"
17673 },
17674 "month" : {
17675 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
17676 "maximum" : 12,
17677 "minimum" : 1,
17678 "optional" : 1,
17679 "type" : "integer",
17680 "typetext" : "<integer> (1 - 12)"
17681 },
17682 "orderby" : {
17683 "description" : "Remote sorting configuration(JSON, ExtJS compatible).",
17684 "maxLength" : 4096,
17685 "optional" : 1,
17686 "type" : "string",
17687 "typetext" : "<string>"
17688 },
17689 "starttime" : {
17690 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
17691 "minimum" : 0,
17692 "optional" : 1,
17693 "type" : "integer",
17694 "typetext" : "<integer> (0 - N)"
17695 },
17696 "year" : {
17697 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
17698 "maximum" : 3000,
17699 "minimum" : 1900,
17700 "optional" : 1,
17701 "type" : "integer",
17702 "typetext" : "<integer> (1900 - 3000)"
17703 }
17704 }
17705 },
17706 "permissions" : {
17707 "check" : [
17708 "admin",
17709 "qmanager",
17710 "audit"
17711 ]
17712 },
17713 "returns" : {
17714 "items" : {
17715 "properties" : {
17716 "bytes" : {
17717 "description" : "Mail traffic (Bytes).",
17718 "type" : "number"
17719 },
17720 "count" : {
17721 "description" : "Mail count.",
17722 "optional" : 1,
17723 "type" : "number"
17724 },
17725 "sender" : {
17726 "description" : "Sender email.",
17727 "type" : "string"
17728 },
17729 "viruscount" : {
17730 "description" : "Number of sent virus mails.",
17731 "optional" : 1,
17732 "type" : "number"
17733 }
17734 },
17735 "type" : "object"
17736 },
17737 "links" : [
17738 {
17739 "href" : "{sender}",
17740 "rel" : "child"
17741 }
17742 ],
17743 "type" : "array"
17744 }
17745 }
17746 },
17747 "leaf" : 1,
17748 "path" : "/statistics/sender",
17749 "text" : "sender"
17750 },
17751 {
17752 "info" : {
17753 "GET" : {
17754 "allowtoken" : 1,
17755 "description" : "Receiver Address Statistics.",
17756 "method" : "GET",
17757 "name" : "receiver",
17758 "parameters" : {
17759 "additionalProperties" : 0,
17760 "properties" : {
17761 "day" : {
17762 "description" : "Day of month. Get statistics for a single day.",
17763 "maximum" : 31,
17764 "minimum" : 1,
17765 "optional" : 1,
17766 "type" : "integer",
17767 "typetext" : "<integer> (1 - 31)"
17768 },
17769 "endtime" : {
17770 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17771 "minimum" : 1,
17772 "optional" : 1,
17773 "type" : "integer",
17774 "typetext" : "<integer> (1 - N)"
17775 },
17776 "filter" : {
17777 "description" : "Receiver address filter.",
17778 "maxLength" : 512,
17779 "optional" : 1,
17780 "type" : "string",
17781 "typetext" : "<string>"
17782 },
17783 "month" : {
17784 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
17785 "maximum" : 12,
17786 "minimum" : 1,
17787 "optional" : 1,
17788 "type" : "integer",
17789 "typetext" : "<integer> (1 - 12)"
17790 },
17791 "orderby" : {
17792 "description" : "Remote sorting configuration(JSON, ExtJS compatible).",
17793 "maxLength" : 4096,
17794 "optional" : 1,
17795 "type" : "string",
17796 "typetext" : "<string>"
17797 },
17798 "starttime" : {
17799 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
17800 "minimum" : 0,
17801 "optional" : 1,
17802 "type" : "integer",
17803 "typetext" : "<integer> (0 - N)"
17804 },
17805 "year" : {
17806 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
17807 "maximum" : 3000,
17808 "minimum" : 1900,
17809 "optional" : 1,
17810 "type" : "integer",
17811 "typetext" : "<integer> (1900 - 3000)"
17812 }
17813 }
17814 },
17815 "permissions" : {
17816 "check" : [
17817 "admin",
17818 "qmanager",
17819 "audit"
17820 ]
17821 },
17822 "returns" : {
17823 "items" : {
17824 "properties" : {
17825 "bytes" : {
17826 "description" : "Mail traffic (Bytes).",
17827 "type" : "number"
17828 },
17829 "count" : {
17830 "description" : "Mail count.",
17831 "optional" : 1,
17832 "type" : "number"
17833 },
17834 "receiver" : {
17835 "description" : "Sender email.",
17836 "type" : "string"
17837 },
17838 "spamcount" : {
17839 "description" : "Number of sent spam mails.",
17840 "optional" : 1,
17841 "type" : "number"
17842 },
17843 "viruscount" : {
17844 "description" : "Number of sent virus mails.",
17845 "optional" : 1,
17846 "type" : "number"
17847 }
17848 },
17849 "type" : "object"
17850 },
17851 "links" : [
17852 {
17853 "href" : "{receiver}",
17854 "rel" : "child"
17855 }
17856 ],
17857 "type" : "array"
17858 }
17859 }
17860 },
17861 "leaf" : 1,
17862 "path" : "/statistics/receiver",
17863 "text" : "receiver"
17864 },
17865 {
17866 "info" : {
17867 "GET" : {
17868 "allowtoken" : 1,
17869 "description" : "Mail Domains Statistics.",
17870 "method" : "GET",
17871 "name" : "domains",
17872 "parameters" : {
17873 "additionalProperties" : 0,
17874 "properties" : {
17875 "day" : {
17876 "description" : "Day of month. Get statistics for a single day.",
17877 "maximum" : 31,
17878 "minimum" : 1,
17879 "optional" : 1,
17880 "type" : "integer",
17881 "typetext" : "<integer> (1 - 31)"
17882 },
17883 "endtime" : {
17884 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17885 "minimum" : 1,
17886 "optional" : 1,
17887 "type" : "integer",
17888 "typetext" : "<integer> (1 - N)"
17889 },
17890 "month" : {
17891 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
17892 "maximum" : 12,
17893 "minimum" : 1,
17894 "optional" : 1,
17895 "type" : "integer",
17896 "typetext" : "<integer> (1 - 12)"
17897 },
17898 "starttime" : {
17899 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
17900 "minimum" : 0,
17901 "optional" : 1,
17902 "type" : "integer",
17903 "typetext" : "<integer> (0 - N)"
17904 },
17905 "year" : {
17906 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
17907 "maximum" : 3000,
17908 "minimum" : 1900,
17909 "optional" : 1,
17910 "type" : "integer",
17911 "typetext" : "<integer> (1900 - 3000)"
17912 }
17913 }
17914 },
17915 "permissions" : {
17916 "check" : [
17917 "admin",
17918 "qmanager",
17919 "audit"
17920 ]
17921 },
17922 "returns" : {
17923 "items" : {
17924 "properties" : {
17925 "bytes_in" : {
17926 "description" : "Incoming mail traffic (Bytes).",
17927 "type" : "number"
17928 },
17929 "bytes_out" : {
17930 "description" : "Outgoing mail traffic (Bytes).",
17931 "type" : "number"
17932 },
17933 "count_in" : {
17934 "description" : "Incoming mail count.",
17935 "type" : "number"
17936 },
17937 "count_out" : {
17938 "description" : "Outgoing mail count.",
17939 "type" : "number"
17940 },
17941 "domain" : {
17942 "description" : "Domain name.",
17943 "type" : "string"
17944 },
17945 "spamcount_in" : {
17946 "description" : "Incoming spam mails.",
17947 "type" : "number"
17948 },
17949 "spamcount_out" : {
17950 "description" : "Outgoing spam mails.",
17951 "type" : "number"
17952 },
17953 "viruscount_in" : {
17954 "description" : "Number of incoming virus mails.",
17955 "type" : "number"
17956 },
17957 "viruscount_out" : {
17958 "description" : "Number of outgoing virus mails.",
17959 "type" : "number"
17960 }
17961 },
17962 "type" : "object"
17963 },
17964 "type" : "array"
17965 }
17966 }
17967 },
17968 "leaf" : 1,
17969 "path" : "/statistics/domains",
17970 "text" : "domains"
17971 },
17972 {
17973 "info" : {
17974 "GET" : {
17975 "allowtoken" : 1,
17976 "description" : "General Mail Statistics.",
17977 "method" : "GET",
17978 "name" : "mail",
17979 "parameters" : {
17980 "additionalProperties" : 0,
17981 "properties" : {
17982 "day" : {
17983 "description" : "Day of month. Get statistics for a single day.",
17984 "maximum" : 31,
17985 "minimum" : 1,
17986 "optional" : 1,
17987 "type" : "integer",
17988 "typetext" : "<integer> (1 - 31)"
17989 },
17990 "endtime" : {
17991 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
17992 "minimum" : 1,
17993 "optional" : 1,
17994 "type" : "integer",
17995 "typetext" : "<integer> (1 - N)"
17996 },
17997 "month" : {
17998 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
17999 "maximum" : 12,
18000 "minimum" : 1,
18001 "optional" : 1,
18002 "type" : "integer",
18003 "typetext" : "<integer> (1 - 12)"
18004 },
18005 "starttime" : {
18006 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
18007 "minimum" : 0,
18008 "optional" : 1,
18009 "type" : "integer",
18010 "typetext" : "<integer> (0 - N)"
18011 },
18012 "year" : {
18013 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
18014 "maximum" : 3000,
18015 "minimum" : 1900,
18016 "optional" : 1,
18017 "type" : "integer",
18018 "typetext" : "<integer> (1900 - 3000)"
18019 }
18020 }
18021 },
18022 "permissions" : {
18023 "check" : [
18024 "admin",
18025 "qmanager",
18026 "audit"
18027 ]
18028 },
18029 "returns" : {
18030 "properties" : {
18031 "avptime" : {
18032 "description" : "Average mail processing time in seconds.",
18033 "type" : "number"
18034 },
18035 "bounces_in" : {
18036 "description" : "Incoming bounce mail count (sender = <>).",
18037 "type" : "number"
18038 },
18039 "bounces_out" : {
18040 "description" : "Outgoing bounce mail count (sender = <>).",
18041 "type" : "number"
18042 },
18043 "bytes_in" : {
18044 "description" : "Incoming mail traffic (bytes).",
18045 "type" : "number"
18046 },
18047 "bytes_out" : {
18048 "description" : "Outgoing mail traffic (bytes).",
18049 "type" : "number"
18050 },
18051 "count" : {
18052 "description" : "Overall mail count (in and out).",
18053 "type" : "number"
18054 },
18055 "count_in" : {
18056 "description" : "Incoming mail count.",
18057 "type" : "number"
18058 },
18059 "count_out" : {
18060 "description" : "Outgoing mail count.",
18061 "type" : "number"
18062 },
18063 "glcount" : {
18064 "description" : "Number of greylisted mails.",
18065 "type" : "number"
18066 },
18067 "junk_in" : {
18068 "description" : "Incoming junk mail count (viruscount_in + spamcount_in + glcount + spfcount + rbl_rejects + pregreet_rejects).",
18069 "type" : "number"
18070 },
18071 "junk_out" : {
18072 "description" : "Outgoing junk mail count (viruscount_out + spamcount_out).",
18073 "type" : "number"
18074 },
18075 "pregreet_rejects" : {
18076 "description" : "PREGREET recject count.",
18077 "type" : "integer"
18078 },
18079 "rbl_rejects" : {
18080 "description" : "Number of RBL rejects.",
18081 "type" : "integer"
18082 },
18083 "spamcount_in" : {
18084 "description" : "Incoming spam mails.",
18085 "type" : "number"
18086 },
18087 "spamcount_out" : {
18088 "description" : "Outgoing spam mails.",
18089 "type" : "number"
18090 },
18091 "spfcount" : {
18092 "description" : "Mails rejected by SPF.",
18093 "type" : "number"
18094 },
18095 "viruscount_in" : {
18096 "description" : "Number of incoming virus mails.",
18097 "type" : "number"
18098 },
18099 "viruscount_out" : {
18100 "description" : "Number of outgoing virus mails.",
18101 "type" : "number"
18102 }
18103 },
18104 "type" : "object"
18105 }
18106 }
18107 },
18108 "leaf" : 1,
18109 "path" : "/statistics/mail",
18110 "text" : "mail"
18111 },
18112 {
18113 "info" : {
18114 "GET" : {
18115 "allowtoken" : 1,
18116 "description" : "Mail Count Statistics.",
18117 "method" : "GET",
18118 "name" : "recent",
18119 "parameters" : {
18120 "additionalProperties" : 0,
18121 "properties" : {
18122 "hours" : {
18123 "default" : 12,
18124 "description" : "How many hours you want to get",
18125 "maximum" : 24,
18126 "minimum" : 1,
18127 "optional" : 1,
18128 "type" : "integer",
18129 "typetext" : "<integer> (1 - 24)"
18130 },
18131 "timespan" : {
18132 "default" : 1800,
18133 "description" : "The Timespan for one datapoint (in seconds)",
18134 "maximum" : 1800,
18135 "minimum" : 1,
18136 "optional" : 1,
18137 "type" : "integer",
18138 "typetext" : "<integer> (1 - 1800)"
18139 }
18140 }
18141 },
18142 "permissions" : {
18143 "check" : [
18144 "admin",
18145 "qmanager",
18146 "audit"
18147 ]
18148 },
18149 "returns" : {
18150 "items" : {
18151 "properties" : {
18152 "bytes_in" : {
18153 "description" : "Number of incoming bytes mails.",
18154 "type" : "number"
18155 },
18156 "bytes_out" : {
18157 "description" : "Number of outgoing bytes mails.",
18158 "type" : "number"
18159 },
18160 "count" : {
18161 "description" : "Overall mail count (in and out).",
18162 "type" : "number"
18163 },
18164 "count_in" : {
18165 "description" : "Incoming mail count.",
18166 "type" : "number"
18167 },
18168 "count_out" : {
18169 "description" : "Outgoing mail count.",
18170 "type" : "number"
18171 },
18172 "index" : {
18173 "description" : "Time index.",
18174 "type" : "integer"
18175 },
18176 "spam" : {
18177 "description" : "Overall spam mail count (in and out).",
18178 "type" : "number"
18179 },
18180 "spam_in" : {
18181 "description" : "Incoming spam mails (spamcount_in + glcount + spfcount).",
18182 "type" : "number"
18183 },
18184 "spam_out" : {
18185 "description" : "Outgoing spam mails.",
18186 "type" : "number"
18187 },
18188 "time" : {
18189 "description" : "Time (Unix epoch).",
18190 "type" : "integer"
18191 },
18192 "timespan" : {
18193 "description" : "Timespan in seconds for one data point",
18194 "type" : "number"
18195 },
18196 "virus_in" : {
18197 "description" : "Number of incoming virus mails.",
18198 "type" : "number"
18199 },
18200 "virus_out" : {
18201 "description" : "Number of outgoing virus mails.",
18202 "type" : "number"
18203 }
18204 },
18205 "type" : "object"
18206 },
18207 "type" : "array"
18208 }
18209 }
18210 },
18211 "leaf" : 1,
18212 "path" : "/statistics/recent",
18213 "text" : "recent"
18214 },
18215 {
18216 "info" : {
18217 "GET" : {
18218 "allowtoken" : 1,
18219 "description" : "Top recent Mail Receivers (including spam)",
18220 "method" : "GET",
18221 "name" : "recentreceivers",
18222 "parameters" : {
18223 "additionalProperties" : 0,
18224 "properties" : {
18225 "hours" : {
18226 "default" : 12,
18227 "description" : "How many hours you want to get",
18228 "maximum" : 24,
18229 "minimum" : 1,
18230 "optional" : 1,
18231 "type" : "integer",
18232 "typetext" : "<integer> (1 - 24)"
18233 },
18234 "limit" : {
18235 "default" : 5,
18236 "description" : "The maximum number of receivers to return.",
18237 "maximum" : 50,
18238 "minimum" : 1,
18239 "optional" : 1,
18240 "type" : "integer",
18241 "typetext" : "<integer> (1 - 50)"
18242 }
18243 }
18244 },
18245 "permissions" : {
18246 "check" : [
18247 "admin",
18248 "qmanager",
18249 "audit"
18250 ]
18251 },
18252 "returns" : {
18253 "items" : {
18254 "properties" : {
18255 "count" : {
18256 "description" : "The count of incoming not blocked E-Mails",
18257 "type" : "integer"
18258 },
18259 "receiver" : {
18260 "description" : "The receiver",
18261 "type" : "string"
18262 }
18263 },
18264 "type" : "object"
18265 },
18266 "type" : "array"
18267 }
18268 }
18269 },
18270 "leaf" : 1,
18271 "path" : "/statistics/recentreceivers",
18272 "text" : "recentreceivers"
18273 },
18274 {
18275 "info" : {
18276 "GET" : {
18277 "allowtoken" : 1,
18278 "description" : "Mail Count Statistics.",
18279 "method" : "GET",
18280 "name" : "mailcount",
18281 "parameters" : {
18282 "additionalProperties" : 0,
18283 "properties" : {
18284 "day" : {
18285 "description" : "Day of month. Get statistics for a single day.",
18286 "maximum" : 31,
18287 "minimum" : 1,
18288 "optional" : 1,
18289 "type" : "integer",
18290 "typetext" : "<integer> (1 - 31)"
18291 },
18292 "endtime" : {
18293 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
18294 "minimum" : 1,
18295 "optional" : 1,
18296 "type" : "integer",
18297 "typetext" : "<integer> (1 - N)"
18298 },
18299 "month" : {
18300 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
18301 "maximum" : 12,
18302 "minimum" : 1,
18303 "optional" : 1,
18304 "type" : "integer",
18305 "typetext" : "<integer> (1 - 12)"
18306 },
18307 "starttime" : {
18308 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
18309 "minimum" : 0,
18310 "optional" : 1,
18311 "type" : "integer",
18312 "typetext" : "<integer> (0 - N)"
18313 },
18314 "timespan" : {
18315 "default" : 3600,
18316 "description" : "Return Mails/<timespan>, where <timespan> is specified in seconds.",
18317 "maximum" : 31622400,
18318 "minimum" : 3600,
18319 "optional" : 1,
18320 "type" : "integer",
18321 "typetext" : "<integer> (3600 - 31622400)"
18322 },
18323 "year" : {
18324 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
18325 "maximum" : 3000,
18326 "minimum" : 1900,
18327 "optional" : 1,
18328 "type" : "integer",
18329 "typetext" : "<integer> (1900 - 3000)"
18330 }
18331 }
18332 },
18333 "permissions" : {
18334 "check" : [
18335 "admin",
18336 "qmanager",
18337 "audit"
18338 ]
18339 },
18340 "returns" : {
18341 "items" : {
18342 "properties" : {
18343 "bounces_in" : {
18344 "description" : "Incoming bounce mail count (sender = <>).",
18345 "type" : "number"
18346 },
18347 "bounces_out" : {
18348 "description" : "Outgoing bounce mail count (sender = <>).",
18349 "type" : "number"
18350 },
18351 "count" : {
18352 "description" : "Overall mail count (in and out).",
18353 "type" : "number"
18354 },
18355 "count_in" : {
18356 "description" : "Incoming mail count.",
18357 "type" : "number"
18358 },
18359 "count_out" : {
18360 "description" : "Outgoing mail count.",
18361 "type" : "number"
18362 },
18363 "index" : {
18364 "description" : "Time index.",
18365 "type" : "integer"
18366 },
18367 "pregreet_rejects" : {
18368 "description" : "PREGREET recject count.",
18369 "type" : "integer"
18370 },
18371 "rbl_rejects" : {
18372 "description" : "Number of RBL rejects.",
18373 "type" : "integer"
18374 },
18375 "spamcount_in" : {
18376 "description" : "Incoming spam mails (spamcount_in + glcount + spfcount + rbl_rejects + pregreet_rejects).",
18377 "type" : "number"
18378 },
18379 "spamcount_out" : {
18380 "description" : "Outgoing spam mails.",
18381 "type" : "number"
18382 },
18383 "time" : {
18384 "description" : "Time (Unix epoch).",
18385 "type" : "integer"
18386 },
18387 "viruscount_in" : {
18388 "description" : "Number of incoming virus mails.",
18389 "type" : "number"
18390 },
18391 "viruscount_out" : {
18392 "description" : "Number of outgoing virus mails.",
18393 "type" : "number"
18394 }
18395 },
18396 "type" : "object"
18397 },
18398 "type" : "array"
18399 }
18400 }
18401 },
18402 "leaf" : 1,
18403 "path" : "/statistics/mailcount",
18404 "text" : "mailcount"
18405 },
18406 {
18407 "info" : {
18408 "GET" : {
18409 "allowtoken" : 1,
18410 "description" : "Get Statistics about detected Viruses.",
18411 "method" : "GET",
18412 "name" : "virus",
18413 "parameters" : {
18414 "additionalProperties" : 0,
18415 "properties" : {
18416 "day" : {
18417 "description" : "Day of month. Get statistics for a single day.",
18418 "maximum" : 31,
18419 "minimum" : 1,
18420 "optional" : 1,
18421 "type" : "integer",
18422 "typetext" : "<integer> (1 - 31)"
18423 },
18424 "endtime" : {
18425 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
18426 "minimum" : 1,
18427 "optional" : 1,
18428 "type" : "integer",
18429 "typetext" : "<integer> (1 - N)"
18430 },
18431 "month" : {
18432 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
18433 "maximum" : 12,
18434 "minimum" : 1,
18435 "optional" : 1,
18436 "type" : "integer",
18437 "typetext" : "<integer> (1 - 12)"
18438 },
18439 "starttime" : {
18440 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
18441 "minimum" : 0,
18442 "optional" : 1,
18443 "type" : "integer",
18444 "typetext" : "<integer> (0 - N)"
18445 },
18446 "year" : {
18447 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
18448 "maximum" : 3000,
18449 "minimum" : 1900,
18450 "optional" : 1,
18451 "type" : "integer",
18452 "typetext" : "<integer> (1900 - 3000)"
18453 }
18454 }
18455 },
18456 "permissions" : {
18457 "check" : [
18458 "admin",
18459 "qmanager",
18460 "audit"
18461 ]
18462 },
18463 "returns" : {
18464 "items" : {
18465 "properties" : {
18466 "count" : {
18467 "description" : "Detection count.",
18468 "type" : "integer"
18469 },
18470 "name" : {
18471 "description" : "Virus name.",
18472 "type" : "string"
18473 }
18474 },
18475 "type" : "object"
18476 },
18477 "type" : "array"
18478 }
18479 }
18480 },
18481 "leaf" : 1,
18482 "path" : "/statistics/virus",
18483 "text" : "virus"
18484 },
18485 {
18486 "info" : {
18487 "GET" : {
18488 "allowtoken" : 1,
18489 "description" : "Get the count of spam mails grouped by spam score. Count for score 10 includes mails with spam score > 10.",
18490 "method" : "GET",
18491 "name" : "spamscores",
18492 "parameters" : {
18493 "additionalProperties" : 0,
18494 "properties" : {
18495 "day" : {
18496 "description" : "Day of month. Get statistics for a single day.",
18497 "maximum" : 31,
18498 "minimum" : 1,
18499 "optional" : 1,
18500 "type" : "integer",
18501 "typetext" : "<integer> (1 - 31)"
18502 },
18503 "endtime" : {
18504 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
18505 "minimum" : 1,
18506 "optional" : 1,
18507 "type" : "integer",
18508 "typetext" : "<integer> (1 - N)"
18509 },
18510 "month" : {
18511 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
18512 "maximum" : 12,
18513 "minimum" : 1,
18514 "optional" : 1,
18515 "type" : "integer",
18516 "typetext" : "<integer> (1 - 12)"
18517 },
18518 "starttime" : {
18519 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
18520 "minimum" : 0,
18521 "optional" : 1,
18522 "type" : "integer",
18523 "typetext" : "<integer> (0 - N)"
18524 },
18525 "year" : {
18526 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
18527 "maximum" : 3000,
18528 "minimum" : 1900,
18529 "optional" : 1,
18530 "type" : "integer",
18531 "typetext" : "<integer> (1900 - 3000)"
18532 }
18533 }
18534 },
18535 "permissions" : {
18536 "check" : [
18537 "admin",
18538 "qmanager",
18539 "audit"
18540 ]
18541 },
18542 "returns" : {
18543 "items" : {
18544 "properties" : {
18545 "count" : {
18546 "description" : "Detection count.",
18547 "type" : "integer"
18548 },
18549 "level" : {
18550 "description" : "Spam level.",
18551 "type" : "string"
18552 },
18553 "ratio" : {
18554 "description" : "Portion of overall mail count.",
18555 "type" : "number"
18556 }
18557 },
18558 "type" : "object"
18559 },
18560 "type" : "array"
18561 }
18562 }
18563 },
18564 "leaf" : 1,
18565 "path" : "/statistics/spamscores",
18566 "text" : "spamscores"
18567 },
18568 {
18569 "info" : {
18570 "GET" : {
18571 "allowtoken" : 1,
18572 "description" : "Get the count of spam mails grouped by spam score. Count for score 10 includes mails with spam score > 10.",
18573 "method" : "GET",
18574 "name" : "maildistribution",
18575 "parameters" : {
18576 "additionalProperties" : 0,
18577 "properties" : {
18578 "day" : {
18579 "description" : "Day of month. Get statistics for a single day.",
18580 "maximum" : 31,
18581 "minimum" : 1,
18582 "optional" : 1,
18583 "type" : "integer",
18584 "typetext" : "<integer> (1 - 31)"
18585 },
18586 "endtime" : {
18587 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
18588 "minimum" : 1,
18589 "optional" : 1,
18590 "type" : "integer",
18591 "typetext" : "<integer> (1 - N)"
18592 },
18593 "month" : {
18594 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
18595 "maximum" : 12,
18596 "minimum" : 1,
18597 "optional" : 1,
18598 "type" : "integer",
18599 "typetext" : "<integer> (1 - 12)"
18600 },
18601 "starttime" : {
18602 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
18603 "minimum" : 0,
18604 "optional" : 1,
18605 "type" : "integer",
18606 "typetext" : "<integer> (0 - N)"
18607 },
18608 "year" : {
18609 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
18610 "maximum" : 3000,
18611 "minimum" : 1900,
18612 "optional" : 1,
18613 "type" : "integer",
18614 "typetext" : "<integer> (1900 - 3000)"
18615 }
18616 }
18617 },
18618 "permissions" : {
18619 "check" : [
18620 "admin",
18621 "qmanager",
18622 "audit"
18623 ]
18624 },
18625 "returns" : {
18626 "items" : {
18627 "properties" : {
18628 "bounces_in" : {
18629 "description" : "Incoming bounce mail count (sender = <>).",
18630 "type" : "number"
18631 },
18632 "bounces_out" : {
18633 "description" : "Outgoing bounce mail count (sender = <>).",
18634 "type" : "number"
18635 },
18636 "count" : {
18637 "description" : "Overall mail count (in and out).",
18638 "type" : "number"
18639 },
18640 "count_in" : {
18641 "description" : "Incoming mail count.",
18642 "type" : "number"
18643 },
18644 "count_out" : {
18645 "description" : "Outgoing mail count.",
18646 "type" : "number"
18647 },
18648 "index" : {
18649 "description" : "Hour (0-23).",
18650 "type" : "integer"
18651 },
18652 "spamcount_in" : {
18653 "description" : "Incoming spam mails (spamcount_in + glcount + spfcount).",
18654 "type" : "number"
18655 },
18656 "spamcount_out" : {
18657 "description" : "Outgoing spam mails.",
18658 "type" : "number"
18659 },
18660 "viruscount_in" : {
18661 "description" : "Number of incoming virus mails.",
18662 "type" : "number"
18663 },
18664 "viruscount_out" : {
18665 "description" : "Number of outgoing virus mails.",
18666 "type" : "number"
18667 }
18668 },
18669 "type" : "object"
18670 },
18671 "type" : "array"
18672 }
18673 }
18674 },
18675 "leaf" : 1,
18676 "path" : "/statistics/maildistribution",
18677 "text" : "maildistribution"
18678 },
18679 {
18680 "info" : {
18681 "GET" : {
18682 "allowtoken" : 1,
18683 "description" : "Early SMTP reject count statistic (RBL, PREGREET rejects with postscreen)",
18684 "method" : "GET",
18685 "name" : "rejectcount",
18686 "parameters" : {
18687 "additionalProperties" : 0,
18688 "properties" : {
18689 "day" : {
18690 "description" : "Day of month. Get statistics for a single day.",
18691 "maximum" : 31,
18692 "minimum" : 1,
18693 "optional" : 1,
18694 "type" : "integer",
18695 "typetext" : "<integer> (1 - 31)"
18696 },
18697 "endtime" : {
18698 "description" : "Only consider entries older than 'endtime' (unix epoch). This is set to '<start> + 1day' by default.",
18699 "minimum" : 1,
18700 "optional" : 1,
18701 "type" : "integer",
18702 "typetext" : "<integer> (1 - N)"
18703 },
18704 "month" : {
18705 "description" : "Month. You will get statistics for the whole month if you do not specify a day.",
18706 "maximum" : 12,
18707 "minimum" : 1,
18708 "optional" : 1,
18709 "type" : "integer",
18710 "typetext" : "<integer> (1 - 12)"
18711 },
18712 "starttime" : {
18713 "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
18714 "minimum" : 0,
18715 "optional" : 1,
18716 "type" : "integer",
18717 "typetext" : "<integer> (0 - N)"
18718 },
18719 "timespan" : {
18720 "default" : 3600,
18721 "description" : "Return RBL/PREGREET rejects/<timespan>, where <timespan> is specified in seconds.",
18722 "maximum" : 31622400,
18723 "minimum" : 3600,
18724 "optional" : 1,
18725 "type" : "integer",
18726 "typetext" : "<integer> (3600 - 31622400)"
18727 },
18728 "year" : {
18729 "description" : "Year. Defaults to current year. You will get statistics for the whole year if you do not specify a month or day.",
18730 "maximum" : 3000,
18731 "minimum" : 1900,
18732 "optional" : 1,
18733 "type" : "integer",
18734 "typetext" : "<integer> (1900 - 3000)"
18735 }
18736 }
18737 },
18738 "permissions" : {
18739 "check" : [
18740 "admin",
18741 "qmanager",
18742 "audit"
18743 ]
18744 },
18745 "returns" : {
18746 "items" : {
18747 "properties" : {
18748 "index" : {
18749 "description" : "Time index.",
18750 "type" : "integer"
18751 },
18752 "pregreet_rejects" : {
18753 "description" : "PREGREET recject count.",
18754 "type" : "integer"
18755 },
18756 "rbl_rejects" : {
18757 "description" : "RBL recject count.",
18758 "type" : "integer"
18759 },
18760 "time" : {
18761 "description" : "Time (Unix epoch).",
18762 "type" : "integer"
18763 }
18764 },
18765 "type" : "object"
18766 },
18767 "type" : "array"
18768 }
18769 }
18770 },
18771 "leaf" : 1,
18772 "path" : "/statistics/rejectcount",
18773 "text" : "rejectcount"
18774 }
18775 ],
18776 "info" : {
18777 "GET" : {
18778 "allowtoken" : 1,
18779 "description" : "Directory index.",
18780 "method" : "GET",
18781 "name" : "index",
18782 "parameters" : {
18783 "additionalProperties" : 0
18784 },
18785 "permissions" : {
18786 "check" : [
18787 "admin",
18788 "qmanager",
18789 "audit"
18790 ]
18791 },
18792 "returns" : {
18793 "items" : {
18794 "properties" : {},
18795 "type" : "object"
18796 },
18797 "links" : [
18798 {
18799 "href" : "{name}",
18800 "rel" : "child"
18801 }
18802 ],
18803 "type" : "array"
18804 }
18805 }
18806 },
18807 "leaf" : 0,
18808 "path" : "/statistics",
18809 "text" : "statistics"
18810 },
18811 {
18812 "info" : {
18813 "GET" : {
18814 "allowtoken" : 1,
18815 "description" : "API version details.",
18816 "method" : "GET",
18817 "name" : "version",
18818 "parameters" : {
18819 "additionalProperties" : 0
18820 },
18821 "permissions" : {
18822 "user" : "all"
18823 },
18824 "returns" : {
18825 "properties" : {
18826 "release" : {
18827 "description" : "The current installed Proxmox Mailgateway Release",
18828 "type" : "string"
18829 },
18830 "repoid" : {
18831 "description" : "The short git commit hash ID from which this version was build",
18832 "type" : "string"
18833 },
18834 "version" : {
18835 "description" : "The current installed pmg-api package version",
18836 "type" : "string"
18837 }
18838 },
18839 "type" : "object"
18840 }
18841 }
18842 },
18843 "leaf" : 1,
18844 "path" : "/version",
18845 "text" : "version"
18846 }
18847 ]
18848 ;
18849
PMG Documentation