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