"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"type" : "string"
}
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"leaf" : 0,
"path" : "/config/ruledb/action/bcc",
"text" : "bcc"
- }
- ],
- "info" : {
- "GET" : {
- "description" : "Directory index.",
- "method" : "GET",
- "name" : "index",
- "parameters" : {
- "additionalProperties" : 0
- },
- "returns" : {
- "items" : {
- "properties" : {
- "subdir" : {
- "type" : "string"
- }
- },
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{subdir}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- }
- },
- "leaf" : 0,
- "path" : "/config/ruledb/action",
- "text" : "action"
- },
- {
- "children" : [
+ },
{
"children" : [
{
"info" : {
"GET" : {
- "description" : "Get 'what' group properties",
+ "description" : "Read 'Header Attribute' object settings.",
"method" : "GET",
- "name" : "get_config",
+ "name" : "read_field",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "ogroup" : {
- "description" : "Object Group ID.",
- "type" : "integer",
- "typetext" : "<integer>"
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
"id" : {
- "type" : "integer"
- },
- "info" : {
- "type" : "string"
- },
- "name" : {
"type" : "string"
}
},
}
},
"PUT" : {
- "description" : "Modify 'what' group properties",
+ "description" : "Update 'Header Attribute' object.",
"method" : "PUT",
- "name" : "set_config",
+ "name" : "update_field",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "field" : {
+ "description" : "The Field",
+ "maxLength" : 1024,
+ "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
+ "type" : "string"
+ },
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ },
"info" : {
"description" : "Informational comment.",
"maxLength" : 255,
"typetext" : "<string>"
},
"name" : {
- "description" : "Group name.",
+ "description" : "Action name.",
"maxLength" : 255,
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
- "ogroup" : {
- "description" : "Object Group ID.",
- "type" : "integer",
- "typetext" : "<integer>"
+ "value" : {
+ "description" : "The Value",
+ "maxLength" : 1024,
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
},
"leaf" : 1,
- "path" : "/config/ruledb/what/{ogroup}/config",
- "text" : "config"
- },
- {
- "children" : [
- {
+ "path" : "/config/ruledb/action/field/{id}",
+ "text" : "{id}"
+ }
+ ],
+ "info" : {
+ "POST" : {
+ "description" : "Create 'Header Attribute' object.",
+ "method" : "POST",
+ "name" : "field",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "field" : {
+ "description" : "The Field",
+ "maxLength" : 1024,
+ "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
+ "type" : "string"
+ },
"info" : {
- "DELETE" : {
- "description" : "Remove an object from the 'what' group.",
- "method" : "DELETE",
- "name" : "delete_object",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "id" : {
- "description" : "Object ID.",
- "type" : "integer",
- "typetext" : "<integer>"
- },
- "ogroup" : {
- "description" : "Object Group ID.",
- "type" : "integer",
- "typetext" : "<integer>"
- }
- }
- },
- "protected" : 1,
- "proxyto" : "master",
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "value" : {
+ "description" : "The Value",
+ "maxLength" : 1024,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "description" : "The object ID.",
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ruledb/action/field",
+ "text" : "field"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Read 'Notification' object settings.",
+ "method" : "GET",
+ "name" : "read_notification",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "master",
+ "returns" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Update 'Notification' object.",
+ "method" : "PUT",
+ "name" : "update_notification",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "attach" : {
+ "default" : 0,
+ "description" : "Attach original E-Mail",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "body" : {
+ "description" : "The Notification Body",
+ "maxLength" : 2048,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ },
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "subject" : {
+ "description" : "The Notification subject",
+ "maxLength" : 100,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "to" : {
+ "description" : "The Receiver E-Mail address",
+ "maxLength" : 200,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/ruledb/action/notification/{id}",
+ "text" : "{id}"
+ }
+ ],
+ "info" : {
+ "POST" : {
+ "description" : "Create 'Notification' object.",
+ "method" : "POST",
+ "name" : "notification",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "attach" : {
+ "default" : 0,
+ "description" : "Attach original E-Mail",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "body" : {
+ "description" : "The Notification Body",
+ "maxLength" : 2048,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "subject" : {
+ "description" : "The Notification subject",
+ "maxLength" : 100,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "to" : {
+ "description" : "The Receiver E-Mail address",
+ "maxLength" : 200,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "description" : "The object ID.",
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ruledb/action/notification",
+ "text" : "notification"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Read 'Disclaimer' object settings.",
+ "method" : "GET",
+ "name" : "read_disclaimer",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "master",
+ "returns" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Update 'Disclaimer' object.",
+ "method" : "PUT",
+ "name" : "update_disclaimer",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "disclaimer" : {
+ "description" : "The Disclaimer",
+ "maxLength" : 2048,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ },
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/ruledb/action/disclaimer/{id}",
+ "text" : "{id}"
+ }
+ ],
+ "info" : {
+ "POST" : {
+ "description" : "Create 'Disclaimer' object.",
+ "method" : "POST",
+ "name" : "disclaimer",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "disclaimer" : {
+ "description" : "The Disclaimer",
+ "maxLength" : 2048,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "description" : "The object ID.",
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ruledb/action/disclaimer",
+ "text" : "disclaimer"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Read 'Remove attachments' object settings.",
+ "method" : "GET",
+ "name" : "read_removeattachments",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "master",
+ "returns" : {
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Update 'Remove attachments' object.",
+ "method" : "PUT",
+ "name" : "update_removeattachments",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "all" : {
+ "description" : "Remove all attachments",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "id" : {
+ "description" : "Action Object ID.",
+ "pattern" : "\\d+_\\d+",
+ "type" : "string"
+ },
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "text" : {
+ "description" : "The replacement text.",
+ "maxLength" : 2048,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/ruledb/action/removeattachments/{id}",
+ "text" : "{id}"
+ }
+ ],
+ "info" : {
+ "POST" : {
+ "description" : "Create 'Remove attachments' object.",
+ "method" : "POST",
+ "name" : "removeattachments",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "all" : {
+ "description" : "Remove all attachments",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Action name.",
+ "maxLength" : 255,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "text" : {
+ "description" : "The replacement text.",
+ "maxLength" : 2048,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "description" : "The object ID.",
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ruledb/action/removeattachments",
+ "text" : "removeattachments"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "Directory index.",
+ "method" : "GET",
+ "name" : "index",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "subdir" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{subdir}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ruledb/action",
+ "text" : "action"
+ },
+ {
+ "children" : [
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Get 'what' group properties",
+ "method" : "GET",
+ "name" : "get_config",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "ogroup" : {
+ "description" : "Object Group ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "master",
+ "returns" : {
+ "properties" : {
+ "id" : {
+ "type" : "integer"
+ },
+ "info" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Modify 'what' group properties",
+ "method" : "PUT",
+ "name" : "set_config",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "info" : {
+ "description" : "Informational comment.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "name" : {
+ "description" : "Group name.",
+ "maxLength" : 255,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "ogroup" : {
+ "description" : "Object Group ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/ruledb/what/{ogroup}/config",
+ "text" : "config"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "DELETE" : {
+ "description" : "Remove an object from the 'what' group.",
+ "method" : "DELETE",
+ "name" : "delete_object",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "description" : "Object ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
+ "ogroup" : {
+ "description" : "Object Group ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
"returns" : {
"type" : "null"
}
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
"value" : {
"description" : "The Value",
"maxLength" : 1024,
- "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"value" : {
"description" : "The Value",
"maxLength" : 1024,
- "pattern" : "[0-9a-zA-Z\\/\\\\[\\]\\+\\-\\.\\*\\_]+",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"leaf" : 0,
"path" : "/config/ruledb/what/{ogroup}/filenamefilter",
"text" : "filenamefilter"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Read 'Virus Filter' object settings.",
+ "method" : "GET",
+ "name" : "read_virusfilter",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "description" : "Object ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
+ "ogroup" : {
+ "description" : "Object Groups ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "master",
+ "returns" : {
+ "properties" : {
+ "id" : {
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Update 'Virus Filter' object.",
+ "method" : "PUT",
+ "name" : "update_virusfilter",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "id" : {
+ "description" : "Object ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
+ "ogroup" : {
+ "description" : "Object Groups ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/ruledb/what/{ogroup}/virusfilter/{id}",
+ "text" : "{id}"
+ }
+ ],
+ "info" : {
+ "POST" : {
+ "description" : "Add 'Virus Filter' object.",
+ "method" : "POST",
+ "name" : "virusfilter",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "ogroup" : {
+ "description" : "Object Groups ID.",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "description" : "The object ID.",
+ "type" : "integer"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ruledb/what/{ogroup}/virusfilter",
+ "text" : "virusfilter"
}
],
"info" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {},
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"returns" : {
"type" : "null"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
"proxyto" : "master",
"returns" : {
"type" : "null"
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"proxyto" : "master",
"additionalProperties" : 0,
"properties" : {
"accountattr" : {
- "default" : "sAMAccountName",
+ "default" : "sAMAccountName, uid",
"description" : "Account attribute name name.",
+ "format" : "ldap-simple-attr-list",
"optional" : 1,
- "pattern" : "[a-zA-Z0-9]+",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"basedn" : {
"description" : "Base domain name.",
"type" : "string",
"typetext" : "<string>"
},
+ "groupclass" : {
+ "default" : "group, univentionGroup, ipausergroup",
+ "description" : "List of objectclasses for groups.",
+ "format" : "ldap-simple-attr-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"mailattr" : {
- "default" : "mail, userPrincipalName, proxyAddresses, othermailbox",
+ "default" : "mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress",
"description" : "List of mail attribute names.",
- "format" : "string-list",
+ "format" : "ldap-simple-attr-list",
"optional" : 1,
- "pattern" : "[a-zA-Z0-9]+",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"mode" : {
"default" : "ldap",
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"protected" : 1,
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"protected" : 1,
},
"type" : "object"
},
+ "links" : [
+ {
+ "href" : "{pmail}",
+ "rel" : "child"
+ }
+ ],
"type" : "array"
}
}
"text" : "users"
},
{
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "List LDAP group members.",
+ "method" : "GET",
+ "name" : "profile_list_group_members",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "gid" : {
+ "description" : "Group ID",
+ "type" : "number",
+ "typetext" : "<number>"
+ },
+ "profile" : {
+ "description" : "Profile ID.",
+ "format" : "pve-configid",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "account" : {
+ "type" : "string"
+ },
+ "dn" : {
+ "type" : "string"
+ },
+ "pmail" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/ldap/{profile}/groups/{gid}",
+ "text" : "{gid}"
+ }
+ ],
"info" : {
"GET" : {
"description" : "List LDAP groups.",
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"protected" : 1,
"properties" : {
"dn" : {
"type" : "string"
+ },
+ "gid" : {
+ "type" : "number"
}
},
"type" : "object"
},
+ "links" : [
+ {
+ "href" : "{gid}",
+ "rel" : "child"
+ }
+ ],
"type" : "array"
}
}
},
- "leaf" : 1,
- "path" : "/config/ldap/{profile}/groups",
- "text" : "groups"
- }
- ],
+ "leaf" : 0,
+ "path" : "/config/ldap/{profile}/groups",
+ "text" : "groups"
+ }
+ ],
+ "info" : {
+ "DELETE" : {
+ "description" : "Delete an LDAP profile",
+ "method" : "DELETE",
+ "name" : "delete",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "profile" : {
+ "description" : "Profile ID.",
+ "format" : "pve-configid",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ },
+ "GET" : {
+ "description" : "Directory index",
+ "method" : "GET",
+ "name" : "profile_index",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "profile" : {
+ "description" : "Profile ID.",
+ "format" : "pve-configid",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "user" : "all"
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "subdir" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{subdir}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ldap/{profile}",
+ "text" : "{profile}"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "List configured LDAP profiles.",
+ "method" : "GET",
+ "name" : "index",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "master",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "disable" : {
+ "type" : "boolean"
+ },
+ "gcount" : {
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "mcount" : {
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "mode" : {
+ "type" : "string"
+ },
+ "profile" : {
+ "type" : "string"
+ },
+ "server1" : {
+ "type" : "string"
+ },
+ "server2" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "ucount" : {
+ "optional" : 1,
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{profile}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ },
+ "POST" : {
+ "description" : "Add LDAP profile.",
+ "method" : "POST",
+ "name" : "create",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "accountattr" : {
+ "default" : "sAMAccountName, uid",
+ "description" : "Account attribute name name.",
+ "format" : "ldap-simple-attr-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "basedn" : {
+ "description" : "Base domain name.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "binddn" : {
+ "description" : "Bind domain name.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "bindpw" : {
+ "description" : "Bind password.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "comment" : {
+ "description" : "Description.",
+ "maxLength" : 4096,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "disable" : {
+ "description" : "Flag to disable/deactivate the entry.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "filter" : {
+ "description" : "LDAP filter.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "groupbasedn" : {
+ "description" : "Base domain name for groups.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "groupclass" : {
+ "default" : "group, univentionGroup, ipausergroup",
+ "description" : "List of objectclasses for groups.",
+ "format" : "ldap-simple-attr-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "mailattr" : {
+ "default" : "mail, userPrincipalName, proxyAddresses, othermailbox, mailAlternativeAddress",
+ "description" : "List of mail attribute names.",
+ "format" : "ldap-simple-attr-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "mode" : {
+ "default" : "ldap",
+ "description" : "LDAP protocol mode ('ldap' or 'ldaps').",
+ "enum" : [
+ "ldap",
+ "ldaps"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
+ "port" : {
+ "description" : "Specify the port to connect to.",
+ "maximum" : 65535,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 65535)"
+ },
+ "profile" : {
+ "description" : "Profile ID.",
+ "format" : "pve-configid",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "server1" : {
+ "description" : "Server address.",
+ "format" : "address",
+ "maxLength" : 256,
+ "optional" : 0,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "server2" : {
+ "description" : "Fallback server address. Userd when the first server is not available.",
+ "format" : "address",
+ "maxLength" : 256,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ },
+ "type" : "object"
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/config/ldap",
+ "text" : "ldap"
+ },
+ {
+ "children" : [
+ {
"info" : {
"DELETE" : {
- "description" : "Delete an LDAP profile",
+ "description" : "Delete a relay domain",
"method" : "DELETE",
"name" : "delete",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "profile" : {
- "description" : "Profile ID.",
- "format" : "pve-configid",
+ "domain" : {
+ "description" : "Domain name.",
+ "format" : "dns-name",
"type" : "string",
"typetext" : "<string>"
}
}
},
"GET" : {
- "description" : "Directory index",
+ "description" : "Read Domain data (comment).",
"method" : "GET",
- "name" : "profile_index",
+ "name" : "read",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "profile" : {
- "description" : "Profile ID.",
- "format" : "pve-configid",
+ "domain" : {
+ "description" : "Domain name.",
+ "format" : "dns-name",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
- "user" : "all"
+ "check" : [
+ "admin",
+ "audit"
+ ]
},
+ "proxyto" : "master",
"returns" : {
- "items" : {
- "properties" : {
- "subdir" : {
- "type" : "string"
- }
+ "properties" : {
+ "comment" : {
+ "type" : "string"
},
- "type" : "object"
+ "domain" : {
+ "type" : "string"
+ }
},
- "links" : [
- {
- "href" : "{subdir}",
- "rel" : "child"
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Update relay domain data (comment).",
+ "method" : "PUT",
+ "name" : "write",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "comment" : {
+ "description" : "Comment.",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "domain" : {
+ "description" : "Domain name.",
+ "format" : "dns-name",
+ "type" : "string",
+ "typetext" : "<string>"
}
- ],
- "type" : "array"
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "master",
+ "returns" : {
+ "type" : "null"
}
- }
- },
- "leaf" : 0,
- "path" : "/config/ldap/{profile}",
- "text" : "{profile}"
+ }
+ },
+ "leaf" : 1,
+ "path" : "/config/domains/{domain}",
+ "text" : "{domain}"
}
],
"info" : {
"GET" : {
- "description" : "List configured LDAP profiles.",
+ "description" : "List relay domains.",
"method" : "GET",
"name" : "index",
"parameters" : {
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"proxyto" : "master",
"items" : {
"properties" : {
"comment" : {
- "optional" : 1,
- "type" : "string"
- },
- "disable" : {
- "type" : "boolean"
- },
- "gcount" : {
- "optional" : 1,
- "type" : "integer"
- },
- "mcount" : {
- "optional" : 1,
- "type" : "integer"
- },
- "mode" : {
- "type" : "string"
- },
- "profile" : {
"type" : "string"
},
- "server1" : {
- "type" : "string"
- },
- "server2" : {
- "optional" : 1,
+ "domain" : {
"type" : "string"
- },
- "ucount" : {
- "optional" : 1,
- "type" : "integer"
}
},
"type" : "object"
},
"links" : [
{
- "href" : "{profile}",
+ "href" : "{domain}",
"rel" : "child"
}
],
}
},
"POST" : {
- "description" : "Add LDAP profile.",
+ "description" : "Add relay domain.",
"method" : "POST",
"name" : "create",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "accountattr" : {
- "default" : "sAMAccountName",
- "description" : "Account attribute name name.",
- "optional" : 1,
- "pattern" : "[a-zA-Z0-9]+",
- "type" : "string"
- },
- "basedn" : {
- "description" : "Base domain name.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "binddn" : {
- "description" : "Bind domain name.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "bindpw" : {
- "description" : "Bind password.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
"comment" : {
- "description" : "Description.",
- "maxLength" : 4096,
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "disable" : {
- "description" : "Flag to disable/deactivate the entry.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
- "filter" : {
- "description" : "LDAP filter.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "groupbasedn" : {
- "description" : "Base domain name for groups.",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- },
- "mailattr" : {
- "default" : "mail, userPrincipalName, proxyAddresses, othermailbox",
- "description" : "List of mail attribute names.",
- "format" : "string-list",
- "optional" : 1,
- "pattern" : "[a-zA-Z0-9]+",
- "type" : "string"
- },
- "mode" : {
- "default" : "ldap",
- "description" : "LDAP protocol mode ('ldap' or 'ldaps').",
- "enum" : [
- "ldap",
- "ldaps"
- ],
- "optional" : 1,
- "type" : "string"
- },
- "port" : {
- "description" : "Specify the port to connect to.",
- "maximum" : 65535,
- "minimum" : 1,
+ "description" : "Comment.",
"optional" : 1,
- "type" : "integer",
- "typetext" : "<integer> (1 - 65535)"
- },
- "profile" : {
- "description" : "Profile ID.",
- "format" : "pve-configid",
- "type" : "string",
- "typetext" : "<string>"
- },
- "server1" : {
- "description" : "Server address.",
- "format" : "address",
- "maxLength" : 256,
- "optional" : 0,
"type" : "string",
"typetext" : "<string>"
},
- "server2" : {
- "description" : "Fallback server address. Userd when the first server is not available.",
- "format" : "address",
- "maxLength" : 256,
- "optional" : 1,
+ "domain" : {
+ "description" : "Domain name.",
+ "format" : "dns-name",
"type" : "string",
"typetext" : "<string>"
}
- },
- "type" : "object"
+ }
},
"permissions" : {
"check" : [
}
},
"leaf" : 0,
- "path" : "/config/ldap",
- "text" : "ldap"
+ "path" : "/config/domains",
+ "text" : "domains"
},
{
"children" : [
{
"info" : {
"DELETE" : {
- "description" : "Delete a relay domain",
+ "description" : "Delete a fetchmail configuration entry.",
"method" : "DELETE",
"name" : "delete",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "domain" : {
- "description" : "Domain name.",
- "format" : "dns-name",
- "type" : "string",
- "typetext" : "<string>"
+ "id" : {
+ "description" : "Unique ID",
+ "maxLength" : 16,
+ "pattern" : "[A-Za-z0-9]+",
+ "type" : "string"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
},
"GET" : {
- "description" : "Read Domain data (comment).",
+ "description" : "Read fetchmail user configuration.",
"method" : "GET",
"name" : "read",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "domain" : {
- "description" : "Domain name.",
- "format" : "dns-name",
- "type" : "string",
- "typetext" : "<string>"
+ "id" : {
+ "description" : "Unique ID",
+ "maxLength" : 16,
+ "pattern" : "[A-Za-z0-9]+",
+ "type" : "string"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "protected" : 1,
"proxyto" : "master",
"returns" : {
"properties" : {
- "comment" : {
+ "enable" : {
+ "default" : 0,
+ "description" : "Flag to enable or disable polling.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "Unique ID",
+ "maxLength" : 16,
+ "pattern" : "[A-Za-z0-9]+",
+ "type" : "string"
+ },
+ "interval" : {
+ "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
+ "maximum" : 2016,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "keep" : {
+ "default" : 0,
+ "description" : "Keep retrieved messages on the remote mailserver.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "pass" : {
+ "description" : "The password used tfor server login.",
+ "maxLength" : 64,
+ "optional" : 1,
+ "type" : "string"
+ },
+ "port" : {
+ "description" : "Port number.",
+ "maximum" : 65535,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "protocol" : {
+ "description" : "Specify the protocol to use when communicating with the remote mailserver",
+ "enum" : [
+ "pop3",
+ "imap"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
+ "server" : {
+ "description" : "Server address (IP or DNS name).",
+ "format" : "address",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "ssl" : {
+ "default" : 0,
+ "description" : "Use SSL.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "target" : {
+ "description" : "The target email address (where to deliver fetched mails).",
+ "maxLength" : 512,
+ "minLength" : 3,
+ "optional" : 1,
+ "pattern" : "(?:|[^\\s\\/\\@]+\\@[^\\s\\/\\@]+)",
+ "type" : "string"
+ },
+ "user" : {
+ "description" : "The user identification to be used when logging in to the server",
+ "maxLength" : 64,
+ "minLength" : 1,
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "description" : "Update fetchmail user configuration.",
+ "method" : "PUT",
+ "name" : "write",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "enable" : {
+ "default" : 0,
+ "description" : "Flag to enable or disable polling.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "id" : {
+ "description" : "Unique ID",
+ "maxLength" : 16,
+ "pattern" : "[A-Za-z0-9]+",
+ "type" : "string"
+ },
+ "interval" : {
+ "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
+ "maximum" : 2016,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 2016)"
+ },
+ "keep" : {
+ "default" : 0,
+ "description" : "Keep retrieved messages on the remote mailserver.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "pass" : {
+ "description" : "The password used tfor server login.",
+ "maxLength" : 64,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "port" : {
+ "description" : "Port number.",
+ "maximum" : 65535,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 65535)"
+ },
+ "protocol" : {
+ "description" : "Specify the protocol to use when communicating with the remote mailserver",
+ "enum" : [
+ "pop3",
+ "imap"
+ ],
+ "optional" : 1,
"type" : "string"
},
- "domain" : {
- "type" : "string"
- }
- },
- "type" : "object"
- }
- },
- "PUT" : {
- "description" : "Update relay domain data (comment).",
- "method" : "PUT",
- "name" : "write",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
- "comment" : {
- "description" : "Comment.",
+ "server" : {
+ "description" : "Server address (IP or DNS name).",
+ "format" : "address",
+ "optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
- "domain" : {
- "description" : "Domain name.",
- "format" : "dns-name",
+ "ssl" : {
+ "default" : 0,
+ "description" : "Use SSL.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "target" : {
+ "description" : "The target email address (where to deliver fetched mails).",
+ "maxLength" : 512,
+ "minLength" : 3,
+ "optional" : 1,
+ "pattern" : "(?:|[^\\s\\/\\@]+\\@[^\\s\\/\\@]+)",
+ "type" : "string"
+ },
+ "user" : {
+ "description" : "The user identification to be used when logging in to the server",
+ "maxLength" : 64,
+ "minLength" : 1,
+ "optional" : 1,
"type" : "string",
"typetext" : "<string>"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
},
"leaf" : 1,
- "path" : "/config/domains/{domain}",
- "text" : "{domain}"
+ "path" : "/config/fetchmail/{id}",
+ "text" : "{id}"
}
],
"info" : {
"GET" : {
- "description" : "List relay domains.",
+ "description" : "List fetchmail users.",
"method" : "GET",
"name" : "index",
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "protected" : 1,
"proxyto" : "master",
"returns" : {
"items" : {
"properties" : {
- "comment" : {
+ "enable" : {
+ "default" : 0,
+ "description" : "Flag to enable or disable polling.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "id" : {
+ "description" : "Unique ID",
+ "maxLength" : 16,
+ "pattern" : "[A-Za-z0-9]+",
"type" : "string"
},
- "domain" : {
+ "interval" : {
+ "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
+ "maximum" : 2016,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "keep" : {
+ "default" : 0,
+ "description" : "Keep retrieved messages on the remote mailserver.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "pass" : {
+ "description" : "The password used tfor server login.",
+ "maxLength" : 64,
+ "optional" : 1,
+ "type" : "string"
+ },
+ "port" : {
+ "description" : "Port number.",
+ "maximum" : 65535,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "protocol" : {
+ "description" : "Specify the protocol to use when communicating with the remote mailserver",
+ "enum" : [
+ "pop3",
+ "imap"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
+ "server" : {
+ "description" : "Server address (IP or DNS name).",
+ "format" : "address",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "ssl" : {
+ "default" : 0,
+ "description" : "Use SSL.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "target" : {
+ "description" : "The target email address (where to deliver fetched mails).",
+ "maxLength" : 512,
+ "minLength" : 3,
+ "optional" : 1,
+ "pattern" : "(?:|[^\\s\\/\\@]+\\@[^\\s\\/\\@]+)",
+ "type" : "string"
+ },
+ "user" : {
+ "description" : "The user identification to be used when logging in to the server",
+ "maxLength" : 64,
+ "minLength" : 1,
+ "optional" : 1,
"type" : "string"
}
},
},
"links" : [
{
- "href" : "{domain}",
+ "href" : "{id}",
"rel" : "child"
}
],
}
},
"POST" : {
- "description" : "Add relay domain.",
+ "description" : "Create fetchmail user configuration.",
"method" : "POST",
"name" : "create",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
- "comment" : {
- "description" : "Comment.",
+ "enable" : {
+ "default" : 0,
+ "description" : "Flag to enable or disable polling.",
"optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "interval" : {
+ "description" : "Only check this site every <interval> poll cycles. A poll cycle is 5 minutes.",
+ "maximum" : 2016,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 2016)"
+ },
+ "keep" : {
+ "default" : 0,
+ "description" : "Keep retrieved messages on the remote mailserver.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "pass" : {
+ "description" : "The password used tfor server login.",
+ "maxLength" : 64,
"type" : "string",
"typetext" : "<string>"
},
- "domain" : {
- "description" : "Domain name.",
- "format" : "dns-name",
+ "port" : {
+ "description" : "Port number.",
+ "maximum" : 65535,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 65535)"
+ },
+ "protocol" : {
+ "description" : "Specify the protocol to use when communicating with the remote mailserver",
+ "enum" : [
+ "pop3",
+ "imap"
+ ],
+ "type" : "string"
+ },
+ "server" : {
+ "description" : "Server address (IP or DNS name).",
+ "format" : "address",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "ssl" : {
+ "default" : 0,
+ "description" : "Use SSL.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "target" : {
+ "description" : "The target email address (where to deliver fetched mails).",
+ "maxLength" : 512,
+ "minLength" : 3,
+ "pattern" : "(?:|[^\\s\\/\\@]+\\@[^\\s\\/\\@]+)",
+ "type" : "string"
+ },
+ "user" : {
+ "description" : "The user identification to be used when logging in to the server",
+ "maxLength" : 64,
+ "minLength" : 1,
"type" : "string",
"typetext" : "<string>"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
- "type" : "null"
+ "description" : "Unique ID",
+ "maxLength" : 16,
+ "pattern" : "[A-Za-z0-9]+",
+ "type" : "string"
}
}
},
"leaf" : 0,
- "path" : "/config/domains",
- "text" : "domains"
+ "path" : "/config/fetchmail",
+ "text" : "fetchmail"
},
{
"children" : [
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
},
"links" : [
{
- "href" : "{id}",
+ "href" : "{domain}",
"rel" : "child"
}
],
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"items" : {
},
"links" : [
{
- "href" : "{cide}",
+ "href" : "{cidr}",
"rel" : "child"
}
],
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "qmanager",
+ "audit"
]
},
"returns" : {
},
"type" : "object"
},
- "links" : [
- {
- "href" : "{cid}",
- "rel" : "child"
- }
- ],
"type" : "array"
}
},
"method" : "GET",
"name" : "status",
"parameters" : {
- "additionalProperties" : 0
+ "additionalProperties" : 0,
+ "properties" : {
+ "list_single_node" : {
+ "default" : 0,
+ "description" : "List local node if there is no cluster defined. Please note that RSA keys and fingerprint are not valid in that case.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "qmanager",
+ "audit"
]
},
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"type" : "object"
},
"type" : "object"
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"type" : "object"
},
"type" : "object"
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"type" : "object"
},
"dnsbl_sites" : {
"description" : "Optional list of DNS white/blacklist domains (see postscreen_dnsbl_sites parameter).",
+ "format" : "dnsbl-entry-list",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
"typetext" : "<integer> (0 - N)"
},
"ext_port" : {
- "default" : 26,
+ "default" : 25,
"description" : "SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.",
"maximum" : 65535,
"minimum" : 1,
"typetext" : "<boolean>"
},
"int_port" : {
- "default" : 25,
+ "default" : 26,
"description" : "SMTP port number for outgoing mail (trusted).",
"maximum" : 65535,
"minimum" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
- "use_rbl" : {
- "default" : 1,
- "description" : "Use Realtime Blacklists.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
- },
"verifyreceivers" : {
"description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address.",
"enum" : [
},
"type" : "object"
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"type" : "object"
"type" : "integer",
"typetext" : "<integer> (0 - 1000)"
},
+ "clamav_heuristic_score" : {
+ "default" : 3,
+ "description" : "Score for ClamaAV heuristics (Google Safe Browsing database, PhishingScanURLs, ...).",
+ "maximum" : 1000,
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - 1000)"
+ },
"delete" : {
"description" : "A list of settings you want to delete.",
"format" : "pve-configid-list",
"type" : "string"
},
"maxspamsize" : {
- "default" : 204800,
+ "default" : 262144,
"description" : "Maximum size of spam messages in bytes.",
"minimum" : 64,
"optional" : 1,
},
"type" : "object"
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"type" : "object"
},
"type" : "object"
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
"parameters" : {
"additionalProperties" : 0
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "master",
"returns" : {
"type" : "object"
},
"type" : "object"
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"protected" : 1,
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "audit"
]
},
"protected" : 1,
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "node",
"returns" : {
"items" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
+ "proxyto" : "node",
"returns" : {
"type" : "string"
}
}
}
},
- "protected" : 1,
- "proxyto" : "node",
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {},
"path" : "/nodes/{node}/clamav",
"text" : "clamav"
},
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "description" : "SpamAssassin rules status.",
+ "method" : "GET",
+ "name" : "rules_status",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "proxyto" : "node",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "channel" : {
+ "type" : "string"
+ },
+ "last_updated" : {
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "update_avail" : {
+ "type" : "boolean"
+ },
+ "update_version" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "version" : {
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ },
+ "POST" : {
+ "description" : "Update SpamAssassin rules.",
+ "method" : "POST",
+ "name" : "update_rules",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/spamassassin/rules",
+ "text" : "rules"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "Directory index.",
+ "method" : "GET",
+ "name" : "index",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {},
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{subdir}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/nodes/{node}/spamassassin",
+ "text" : "spamassassin"
+ },
{
"children" : [
{
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "node",
"returns" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "node",
"returns" : {
"items" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {},
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "node",
"returns" : {
"items" : {
"enum" : [
"clamav-daemon",
"clamav-freshclam",
+ "fetchmail",
"pmgproxy",
"pmgdaemon",
"pmgpolicy",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"enum" : [
"clamav-daemon",
"clamav-freshclam",
+ "fetchmail",
"pmgproxy",
"pmgdaemon",
"pmgpolicy",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"enum" : [
"clamav-daemon",
"clamav-freshclam",
+ "fetchmail",
"pmgproxy",
"pmgdaemon",
"pmgpolicy",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"enum" : [
"clamav-daemon",
"clamav-freshclam",
+ "fetchmail",
"pmgproxy",
"pmgdaemon",
"pmgpolicy",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"enum" : [
"clamav-daemon",
"clamav-freshclam",
+ "fetchmail",
"pmgproxy",
"pmgdaemon",
"pmgpolicy",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"enum" : [
"clamav-daemon",
"clamav-freshclam",
+ "fetchmail",
"pmgproxy",
"pmgdaemon",
"pmgpolicy",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"returns" : {
"items" : {
"properties" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"returns" : {
"type" : "object"
}
+ },
+ "POST" : {
+ "description" : "Update subscription info.",
+ "method" : "POST",
+ "name" : "update",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "force" : {
+ "default" : 0,
+ "description" : "Always connect to server, even if we have up to date info inside local cache.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ },
+ "PUT" : {
+ "description" : "Set subscription key.",
+ "method" : "PUT",
+ "name" : "set",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "key" : {
+ "description" : "Proxmox Mail Gateway subscription key",
+ "maxLength" : 32,
+ "pattern" : "pmg([cbsp])-[0-9a-f]{10}",
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
}
},
"leaf" : 1,
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "node",
"returns" : {
"type" : "string"
},
"permissions" : {
"check" : [
- "perm",
- "/nodes/{node}",
- [
- "Sys.Audit"
- ]
+ "admin",
+ "audit"
]
},
"proxyto" : "node",
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
"href" : "{id}",
"rel" : "child"
}
- ],
- "type" : "array"
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/nodes/{node}/tracker",
+ "text" : "tracker"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "DELETE" : {
+ "description" : "Delete a backup file.",
+ "method" : "DELETE",
+ "name" : "delete",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "filename" : {
+ "description" : "The backup file name.",
+ "maxLength" : 256,
+ "minLength" : 4,
+ "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ },
+ "GET" : {
+ "description" : "Download a backup file.",
+ "download" : 1,
+ "method" : "GET",
+ "name" : "download",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "filename" : {
+ "description" : "The backup file name.",
+ "maxLength" : 256,
+ "minLength" : 4,
+ "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ },
+ "POST" : {
+ "description" : "Restore the system configuration.",
+ "method" : "POST",
+ "name" : "restore",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "config" : {
+ "default" : 0,
+ "description" : "Restore system configuration.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "database" : {
+ "default" : 1,
+ "description" : "Restore the rule database. This is the default.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "filename" : {
+ "description" : "The backup file name.",
+ "maxLength" : 256,
+ "minLength" : 4,
+ "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "statistic" : {
+ "default" : 0,
+ "description" : "Restore statistic databases. Only considered when you restore the 'database'.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/backup/{filename}",
+ "text" : "{filename}"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "description" : "List all stored backups (files named proxmox-backup_{DATE}.tgz).",
+ "method" : "GET",
+ "name" : "list",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "filename" : {
+ "description" : "The backup file name.",
+ "maxLength" : 256,
+ "minLength" : 4,
+ "pattern" : "pmg-backup_[0-9A-Za-z_-]+\\.tgz",
+ "type" : "string"
+ },
+ "size" : {
+ "description" : "Size of backup file in bytes.",
+ "type" : "integer"
+ },
+ "timestamp" : {
+ "description" : "Backup timestamp (Unix epoch).",
+ "type" : "integer"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{filename}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ },
+ "POST" : {
+ "description" : "Backup the system configuration.",
+ "method" : "POST",
+ "name" : "backup",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "statistic" : {
+ "default" : 1,
+ "description" : "Backup statistic databases.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
}
}
},
"leaf" : 0,
- "path" : "/nodes/{node}/tracker",
- "text" : "tracker"
+ "path" : "/nodes/{node}/backup",
+ "text" : "backup"
},
{
"info" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "node",
"returns" : {
{
"info" : {
"POST" : {
- "description" : "Creates a VNC Shell proxy.",
+ "description" : "Creates a Terminal proxy.",
"method" : "POST",
- "name" : "vncshell",
+ "name" : "termproxy",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
- },
- "websocket" : {
- "default" : 1,
- "description" : "use websocket instead of standard vnc.",
- "optional" : 1,
- "type" : "boolean",
- "typetext" : "<boolean>"
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"protected" : 1,
"returns" : {
"additionalProperties" : 0,
}
},
"leaf" : 1,
- "path" : "/nodes/{node}/vncshell",
- "text" : "vncshell"
+ "path" : "/nodes/{node}/termproxy",
+ "text" : "termproxy"
},
{
"info" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
"returns" : {
"properties" : {
"port" : {
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "node",
"returns" : {
"additionalProperties" : 0,
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "audit"
+ ]
+ },
"proxyto" : "node",
"returns" : {
"additionalProperties" : 0,
},
"type" : "object"
}
+ },
+ "POST" : {
+ "description" : "Reboot or shutdown a node.",
+ "method" : "POST",
+ "name" : "node_cmd",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "command" : {
+ "description" : "Specify the command.",
+ "enum" : [
+ "reboot",
+ "shutdown"
+ ],
+ "type" : "string"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin"
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
}
},
"leaf" : 1,
}
}
},
+ "permissions" : {
+ "check" : [
+ "admin",
+ "qmanager",
+ "audit"
+ ]
+ },
"protected" : 1,
"proxyto" : "master",
"returns" : {
},
"permissions" : {
"check" : [
- "admin"
+ "admin",
+ "qmanager",
+ "audit"
]
},
"protected" : 1,
}
},
"POST" : {
- "description" : "Creat new user",
+ "description" : "Create new user",
"method" : "POST",
"name" : "create",
"parameters" : {
"type" : "string",
"typetext" : "<string>"
},
+ "path" : {
+ "description" : "Verify ticket, and check if user have access on 'path'",
+ "maxLength" : 64,
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"realm" : {
"description" : "You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.",
- "format" : "pmg-realm",
+ "enum" : [
+ "pam",
+ "pmg",
+ "quarantine"
+ ],
"maxLength" : 32,
"optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
+ "type" : "string"
},
"username" : {
"description" : "User name",
"properties" : {
"id" : {
"description" : "Unique ID",
- "maxLength" : 40,
- "pattern" : "C\\d+R\\d+",
+ "maxLength" : 60,
+ "pattern" : "C\\d+R\\d+T\\d+",
"type" : "string"
},
"raw" : {
},
"id" : {
"description" : "Unique ID",
- "maxLength" : 40,
- "pattern" : "C\\d+R\\d+",
+ "maxLength" : 60,
+ "pattern" : "C\\d+R\\d+T\\d+",
"type" : "string"
}
}
"returns" : {
"items" : {
"properties" : {
+ "bytes_in" : {
+ "description" : "Incoming mail traffic (Bytes).",
+ "type" : "number"
+ },
+ "bytes_out" : {
+ "description" : "Outgoing mail traffic (Bytes).",
+ "type" : "number"
+ },
"count_in" : {
"description" : "Incoming mail count.",
"type" : "number"
"description" : "Domain name.",
"type" : "string"
},
- "mbytes_in" : {
- "description" : "Incoming mail traffic (Mebibytes).",
- "type" : "number"
- },
- "mbytes_out" : {
- "description" : "Outgoing mail traffic (Mebibytes).",
- "type" : "number"
- },
"spamcount_in" : {
"description" : "Incoming spam mails.",
"type" : "number"
"type" : "number"
},
"junk_in" : {
- "description" : "Incoming junk mail count (viruscount_in + spamcount_in + glcount + spfcount).",
+ "description" : "Incoming junk mail count (viruscount_in + spamcount_in + glcount + spfcount + rbl_rejects + pregreet_rejects).",
"type" : "number"
},
"junk_out" : {
"description" : "Outgoing junk mail count (viruscount_out + spamcount_out).",
"type" : "number"
},
+ "pregreet_rejects" : {
+ "description" : "PREGREET recject count.",
+ "type" : "integer"
+ },
+ "rbl_rejects" : {
+ "description" : "Number of RBL rejects.",
+ "type" : "integer"
+ },
"spamcount_in" : {
"description" : "Incoming spam mails.",
"type" : "number"
"path" : "/statistics/mail",
"text" : "mail"
},
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Mail Count Statistics.",
+ "method" : "GET",
+ "name" : "recent",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "hours" : {
+ "default" : 12,
+ "description" : "How many hours you want to get",
+ "maximum" : 24,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 24)"
+ },
+ "timespan" : {
+ "default" : 1800,
+ "description" : "The Timespan for one datapoint (in seconds)",
+ "maximum" : 1800,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 1800)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "qmanager",
+ "audit"
+ ]
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "bytes_in" : {
+ "description" : "Number of incoming bytes mails.",
+ "type" : "number"
+ },
+ "bytes_out" : {
+ "description" : "Number of outgoing bytes mails.",
+ "type" : "number"
+ },
+ "count" : {
+ "description" : "Overall mail count (in and out).",
+ "type" : "number"
+ },
+ "count_in" : {
+ "description" : "Incoming mail count.",
+ "type" : "number"
+ },
+ "count_out" : {
+ "description" : "Outgoing mail count.",
+ "type" : "number"
+ },
+ "index" : {
+ "description" : "Time index.",
+ "type" : "integer"
+ },
+ "spam" : {
+ "description" : "Overall spam mail count (in and out).",
+ "type" : "number"
+ },
+ "spam_in" : {
+ "description" : "Incoming spam mails (spamcount_in + glcount + spfcount).",
+ "type" : "number"
+ },
+ "spam_out" : {
+ "description" : "Outgoing spam mails.",
+ "type" : "number"
+ },
+ "time" : {
+ "description" : "Time (Unix epoch).",
+ "type" : "integer"
+ },
+ "timespan" : {
+ "description" : "Timespan in seconds for one data point",
+ "type" : "number"
+ },
+ "virus_in" : {
+ "description" : "Number of incoming virus mails.",
+ "type" : "number"
+ },
+ "virus_out" : {
+ "description" : "Number of outgoing virus mails.",
+ "type" : "number"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/statistics/recent",
+ "text" : "recent"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "description" : "Top recent Mail Receivers (including spam)",
+ "method" : "GET",
+ "name" : "recentreceivers",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "hours" : {
+ "default" : 12,
+ "description" : "How many hours you want to get",
+ "maximum" : 24,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 24)"
+ },
+ "limit" : {
+ "default" : 5,
+ "description" : "The maximum number of receivers to return.",
+ "maximum" : 50,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 50)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "admin",
+ "qmanager",
+ "audit"
+ ]
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "count" : {
+ "description" : "The count of incoming not blocked E-Mails",
+ "type" : "integer"
+ },
+ "receiver" : {
+ "description" : "The receiver",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/statistics/recentreceivers",
+ "text" : "recentreceivers"
+ },
{
"info" : {
"GET" : {
"description" : "Time index.",
"type" : "integer"
},
+ "pregreet_rejects" : {
+ "description" : "PREGREET recject count.",
+ "type" : "integer"
+ },
+ "rbl_rejects" : {
+ "description" : "Number of RBL rejects.",
+ "type" : "integer"
+ },
"spamcount_in" : {
- "description" : "Incoming spam mails (spamcount_in + glcount + spfcount).",
+ "description" : "Incoming spam mails (spamcount_in + glcount + spfcount + rbl_rejects + pregreet_rejects).",
"type" : "number"
},
"spamcount_out" : {
{
"info" : {
"GET" : {
- "description" : "Mail RBL Count Statistics.",
+ "description" : "Early SMTP reject count statistic (RBL, PREGREET rejects with postscreen)",
"method" : "GET",
- "name" : "rblcount",
+ "name" : "rejectcount",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
},
"timespan" : {
"default" : 3600,
- "description" : "Return RBL rejects/<timespan>, where <timespan> is specified in seconds.",
+ "description" : "Return RBL/PREGREET rejects/<timespan>, where <timespan> is specified in seconds.",
"maximum" : 31622400,
"minimum" : 3600,
"optional" : 1,
"returns" : {
"items" : {
"properties" : {
- "count" : {
- "description" : "RBL recject count.",
- "type" : "number"
- },
"index" : {
"description" : "Time index.",
"type" : "integer"
},
+ "pregreet_rejects" : {
+ "description" : "PREGREET recject count.",
+ "type" : "integer"
+ },
+ "rbl_rejects" : {
+ "description" : "RBL recject count.",
+ "type" : "integer"
+ },
"time" : {
"description" : "Time (Unix epoch).",
"type" : "integer"
}
},
"leaf" : 1,
- "path" : "/statistics/rblcount",
- "text" : "rblcount"
+ "path" : "/statistics/rejectcount",
+ "text" : "rejectcount"
}
],
"info" : {