proxmox-mirrors/pmg-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pmg-docs synced 2025-08-15 07:19:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update static schema info

Browse Source 
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2022-11-29 15:55:00 +01:00
parent 0b9926d3fb
commit f4831d949f
2 changed files with 39 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
api-viewer/apidata.js
View File

@ -12547,7 +12547,14 @@ var apiSchema = [
"parameters" : { "parameters" : {
"additionalProperties" : 0, "additionalProperties" : 0,
"properties" : { "properties" : {
"download" : {
"description" : "Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"limit" : { "limit" : {
"description" : "The amount of lines to read from the tasklog.",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer", "type" : "integer",
@ -12560,6 +12567,7 @@ var apiSchema = [
"typetext" : "<string>" "typetext" : "<string>"
}, },
"start" : { "start" : {
"description" : "Start at this line when reading the tasklog",
"minimum" : 0, "minimum" : 0,
"optional" : 1, "optional" : 1,
"type" : "integer", "type" : "integer",
@ -17632,6 +17640,17 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer> (1 - N)" "typetext" : "<integer> (1 - N)"
}, },
"quarantine-type" : {
"default" : "spam",
"description" : "Query this type of quarantine for users.",
"enum" : [
"attachment",
"virus",
"spam"
],
"optional" : 1,
"type" : "string"
},
"starttime" : { "starttime" : {
"description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.", "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
"minimum" : 0, "minimum" : 0,
@ -17866,6 +17885,14 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer> (1 - N)" "typetext" : "<integer> (1 - N)"
}, },
"pmail" : {
"description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
"maxLength" : 512,
"minLength" : 3,
"optional" : 1,
"pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
"type" : "string"
},
"starttime" : { "starttime" : {
"description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.", "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
"minimum" : 0, "minimum" : 0,
@ -17950,6 +17977,14 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer> (1 - N)" "typetext" : "<integer> (1 - N)"
}, },
"pmail" : {
"description" : "List entries for the user with this primary email address. Quarantine users cannot specify this parameter, but it is required for all other roles.",
"maxLength" : 512,
"minLength" : 3,
"optional" : 1,
"pattern" : "(?:[^\\s\\\\@]+\\@[^\\s\\/\\\\@]+)",
"type" : "string"
},
"starttime" : { "starttime" : {
"description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.", "description" : "Only consider entries newer than 'starttime' (unix epoch). Default is 'now - 1day'.",
"minimum" : 0, "minimum" : 0,
@ -18205,7 +18240,8 @@ var apiSchema = [
"check" : [ "check" : [
"admin", "admin",
"qmanager", "qmanager",
"audit" "audit",
"quser"
] ]
}, },
"returns" : { "returns" : {

4
pmgqm.1-synopsis.adoc
View File

@ -29,11 +29,11 @@ Generate and send spam report emails.
Debug mode. Print raw email to stdout instead of sending them. Debug mode. Print raw email to stdout instead of sending them.
`--receiver` `<string>` :: `--receiver` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
Generate report for a single email address. If not specified, generate reports for all users. Generate report for a single email address. If not specified, generate reports for all users.
`--redirect` `<string>` :: `--redirect` `(?:[^\s\\@]+\@[^\s\/\\@]+)` ::
Redirect spam report email to this address. Redirect spam report email to this address.