proxmox-mirrors/pmg-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pmg-docs synced 2025-08-11 18:03:45 +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 2025-02-22 18:22:02 +01:00
parent dab5ae0798
commit fe96611eac
9 changed files with 88 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
api-viewer/apidata.js
View File

@ -2131,6 +2131,13 @@ var apiSchema = [
"description" : "Object Groups ID.", "description" : "Object Groups ID.",
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
},
"only-content" : {
"default" : 0,
"description" : "use content-type from scanning only (ignore filename and header)",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
} }
} }
}, },
@ -2170,6 +2177,13 @@ var apiSchema = [
"description" : "Object Groups ID.", "description" : "Object Groups ID.",
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
},
"only-content" : {
"default" : 0,
"description" : "use content-type from scanning only (ignore filename and header)",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
} }
} }
}, },
@ -2254,6 +2268,13 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
}, },
"top-part-only" : {
"default" : 0,
"description" : "only match the headers in the first MIME-Part",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"value" : { "value" : {
"description" : "The Value", "description" : "The Value",
"maxLength" : 1024, "maxLength" : 1024,
@ -2299,6 +2320,13 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
}, },
"top-part-only" : {
"default" : 0,
"description" : "only match the headers in the first MIME-Part",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"value" : { "value" : {
"description" : "The Value", "description" : "The Value",
"maxLength" : 1024, "maxLength" : 1024,
@ -2509,6 +2537,13 @@ var apiSchema = [
"description" : "Object Groups ID.", "description" : "Object Groups ID.",
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
},
"only-content" : {
"default" : 0,
"description" : "use content-type from scanning only (ignore filename and header)",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
} }
} }
}, },
@ -2548,6 +2583,13 @@ var apiSchema = [
"description" : "Object Groups ID.", "description" : "Object Groups ID.",
"type" : "integer", "type" : "integer",
"typetext" : "<integer>" "typetext" : "<integer>"
},
"only-content" : {
"default" : 0,
"description" : "use content-type from scanning only (ignore filename and header)",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
} }
} }
}, },
@ -9435,6 +9477,7 @@ var apiSchema = [
"active24", "active24",
"ad", "ad",
"ali", "ali",
"alviy",
"anx", "anx",
"artfiles", "artfiles",
"arvan", "arvan",
@ -9463,7 +9506,6 @@ var apiSchema = [
"dnshome", "dnshome",
"dnsimple", "dnsimple",
"dnsservices", "dnsservices",
"do",
"doapi", "doapi",
"domeneshop", "domeneshop",
"dp", "dp",
@ -9496,6 +9538,7 @@ var apiSchema = [
"internetbs", "internetbs",
"inwx", "inwx",
"ionos", "ionos",
"ionos_cloud",
"ipv64", "ipv64",
"ispconfig", "ispconfig",
"jd", "jd",
@ -9507,6 +9550,7 @@ var apiSchema = [
"la", "la",
"leaseweb", "leaseweb",
"lexicon", "lexicon",
"limacity",
"linode", "linode",
"linode_v4", "linode_v4",
"loopia", "loopia",
@ -9535,6 +9579,7 @@ var apiSchema = [
"nsupdate", "nsupdate",
"nw", "nw",
"oci", "oci",
"omglol",
"one", "one",
"online", "online",
"openprovider", "openprovider",
@ -9556,8 +9601,10 @@ var apiSchema = [
"selfhost", "selfhost",
"servercow", "servercow",
"simply", "simply",
"technitium",
"tele3", "tele3",
"tencent", "tencent",
"timeweb",
"transip", "transip",
"udr", "udr",
"ultra", "ultra",
@ -9568,11 +9615,13 @@ var apiSchema = [
"vscale", "vscale",
"vultr", "vultr",
"websupport", "websupport",
"west_cn",
"world4you", "world4you",
"yandex", "yandex360",
"yc", "yc",
"zilore", "zilore",
"zone", "zone",
"zoneedit",
"zonomi" "zonomi"
], ],
"optional" : 1, "optional" : 1,
@ -9709,6 +9758,7 @@ var apiSchema = [
"active24", "active24",
"ad", "ad",
"ali", "ali",
"alviy",
"anx", "anx",
"artfiles", "artfiles",
"arvan", "arvan",
@ -9737,7 +9787,6 @@ var apiSchema = [
"dnshome", "dnshome",
"dnsimple", "dnsimple",
"dnsservices", "dnsservices",
"do",
"doapi", "doapi",
"domeneshop", "domeneshop",
"dp", "dp",
@ -9770,6 +9819,7 @@ var apiSchema = [
"internetbs", "internetbs",
"inwx", "inwx",
"ionos", "ionos",
"ionos_cloud",
"ipv64", "ipv64",
"ispconfig", "ispconfig",
"jd", "jd",
@ -9781,6 +9831,7 @@ var apiSchema = [
"la", "la",
"leaseweb", "leaseweb",
"lexicon", "lexicon",
"limacity",
"linode", "linode",
"linode_v4", "linode_v4",
"loopia", "loopia",
@ -9809,6 +9860,7 @@ var apiSchema = [
"nsupdate", "nsupdate",
"nw", "nw",
"oci", "oci",
"omglol",
"one", "one",
"online", "online",
"openprovider", "openprovider",
@ -9830,8 +9882,10 @@ var apiSchema = [
"selfhost", "selfhost",
"servercow", "servercow",
"simply", "simply",
"technitium",
"tele3", "tele3",
"tencent", "tencent",
"timeweb",
"transip", "transip",
"udr", "udr",
"ultra", "ultra",
@ -9842,11 +9896,13 @@ var apiSchema = [
"vscale", "vscale",
"vultr", "vultr",
"websupport", "websupport",
"west_cn",
"world4you", "world4you",
"yandex", "yandex360",
"yc", "yc",
"zilore", "zilore",
"zone", "zone",
"zoneedit",
"zonomi" "zonomi"
], ],
"optional" : 1, "optional" : 1,
@ -10582,7 +10638,7 @@ var apiSchema = [
}, },
"dkim-use-domain" : { "dkim-use-domain" : {
"default" : "envelope", "default" : "envelope",
"description" : "Whether to sign using the address from the header or the envelope.", "description" : "Whether to sign using the domain found in the header or the envelope.",
"enum" : [ "enum" : [
"header", "header",
"envelope" "envelope"
@ -11061,7 +11117,7 @@ var apiSchema = [
"type" : "string" "type" : "string"
}, },
"smarthost" : { "smarthost" : {
"description" : "When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`)", "description" : "When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`)",
"format" : "address", "format" : "address",
"optional" : 1, "optional" : 1,
"type" : "string", "type" : "string",
@ -11307,7 +11363,7 @@ var apiSchema = [
"properties" : { "properties" : {
"allowhrefs" : { "allowhrefs" : {
"default" : 1, "default" : 1,
"description" : "Allow to view hyperlinks.", "description" : "Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.",
"optional" : 1, "optional" : 1,
"type" : "boolean", "type" : "boolean",
"typetext" : "<boolean>" "typetext" : "<boolean>"
@ -11454,7 +11510,7 @@ var apiSchema = [
"properties" : { "properties" : {
"allowhrefs" : { "allowhrefs" : {
"default" : 1, "default" : 1,
"description" : "Allow to view hyperlinks.", "description" : "Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.",
"optional" : 1, "optional" : 1,
"type" : "boolean", "type" : "boolean",
"typetext" : "<boolean>" "typetext" : "<boolean>"
@ -13043,6 +13099,7 @@ var apiSchema = [
"GET" : { "GET" : {
"allowtoken" : 1, "allowtoken" : 1,
"description" : "Read task log.", "description" : "Read task log.",
"download_allowed" : 1,
"method" : "GET", "method" : "GET",
"name" : "read_task_log", "name" : "read_task_log",
"parameters" : { "parameters" : {
@ -14702,7 +14759,7 @@ var apiSchema = [
"GET" : { "GET" : {
"allowtoken" : 1, "allowtoken" : 1,
"description" : "Download a backup file.", "description" : "Download a backup file.",
"download" : 1, "download_allowed" : 1,
"method" : "GET", "method" : "GET",
"name" : "download", "name" : "download",
"parameters" : { "parameters" : {
@ -14731,7 +14788,7 @@ var apiSchema = [
"protected" : 1, "protected" : 1,
"proxyto" : "node", "proxyto" : "node",
"returns" : { "returns" : {
"type" : "string" "type" : "object"
} }
}, },
"POST" : { "POST" : {
@ -16454,6 +16511,7 @@ var apiSchema = [
"GET" : { "GET" : {
"allowtoken" : 1, "allowtoken" : 1,
"description" : "Read Journal", "description" : "Read Journal",
"download_allowed" : 1,
"method" : "GET", "method" : "GET",
"name" : "journal", "name" : "journal",
"parameters" : { "parameters" : {
@ -18886,7 +18944,7 @@ var apiSchema = [
"GET" : { "GET" : {
"allowtoken" : 1, "allowtoken" : 1,
"description" : "Download E-Mail or Attachment from Quarantine.", "description" : "Download E-Mail or Attachment from Quarantine.",
"download" : 1, "download_allowed" : 1,
"method" : "GET", "method" : "GET",
"name" : "download", "name" : "download",
"parameters" : { "parameters" : {
@ -19664,7 +19722,7 @@ var apiSchema = [
"type" : "number" "type" : "number"
}, },
"pregreet_rejects" : { "pregreet_rejects" : {
"description" : "PREGREET recject count.", "description" : "PREGREET reject count.",
"type" : "integer" "type" : "integer"
}, },
"rbl_rejects" : { "rbl_rejects" : {
@ -19956,7 +20014,7 @@ var apiSchema = [
"type" : "integer" "type" : "integer"
}, },
"pregreet_rejects" : { "pregreet_rejects" : {
"description" : "PREGREET recject count.", "description" : "PREGREET reject count.",
"type" : "integer" "type" : "integer"
}, },
"rbl_rejects" : { "rbl_rejects" : {
@ -20341,11 +20399,11 @@ var apiSchema = [
"type" : "integer" "type" : "integer"
}, },
"pregreet_rejects" : { "pregreet_rejects" : {
"description" : "PREGREET recject count.", "description" : "PREGREET reject count.",
"type" : "integer" "type" : "integer"
}, },
"rbl_rejects" : { "rbl_rejects" : {
"description" : "RBL recject count.", "description" : "RBL reject count.",
"type" : "integer" "type" : "integer"
}, },
"time" : { "time" : {

2
pmg.admin-conf-opts.adoc
View File

@ -32,7 +32,7 @@ Demo mode - do not start SMTP filter.
`dkim-use-domain`: `<envelope | header>` ('default =' `envelope`):: `dkim-use-domain`: `<envelope | header>` ('default =' `envelope`)::
Whether to sign using the address from the header or the envelope. Whether to sign using the domain found in the header or the envelope.
`dkim_selector`: `<string>` :: `dkim_selector`: `<string>` ::

4
pmg.admin-dkim-conf-opts.adoc
View File

@ -1,3 +1,7 @@
`dkim-use-domain`: `<envelope | header>` ('default =' `envelope`)::
Whether to sign using the domain found in the header or the envelope.
`dkim_selector`: `<string>` :: `dkim_selector`: `<string>` ::
Default DKIM selector Default DKIM selector

8
pmg.conf.5-opts.adoc
View File

@ -34,7 +34,7 @@ Demo mode - do not start SMTP filter.
`dkim-use-domain`: `<envelope | header>` ('default =' `envelope`):: `dkim-use-domain`: `<envelope | header>` ('default =' `envelope`)::
Whether to sign using the address from the header or the envelope. Whether to sign using the domain found in the header or the envelope.
`dkim_selector`: `<string>` :: `dkim_selector`: `<string>` ::
@ -218,7 +218,7 @@ Transport protocol for relay host.
`smarthost`: `<string>` :: `smarthost`: `<string>` ::
When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`) When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`)
`smarthostport`: `<integer> (1 - 65535)` ('default =' `25`):: `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::
@ -294,7 +294,7 @@ Whitelist legitimate bounce relays.
`allowhrefs`: `<boolean>` ('default =' `1`):: `allowhrefs`: `<boolean>` ('default =' `1`)::
Allow to view hyperlinks. Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.
`authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`):: `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::
@ -336,7 +336,7 @@ Allow to view images.
`allowhrefs`: `<boolean>` ('default =' `1`):: `allowhrefs`: `<boolean>` ('default =' `1`)::
Allow to view hyperlinks. Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.
`lifetime`: `<integer> (1 - N)` ('default =' `7`):: `lifetime`: `<integer> (1 - N)` ('default =' `7`)::

2
pmg.mail-relaying-conf-opts.adoc
View File

@ -16,7 +16,7 @@ Transport protocol for relay host.
`smarthost`: `<string>` :: `smarthost`: `<string>` ::
When set, all outgoing mails are deliverd to the specified smarthost. (postfix option `default_transport`) When set, all outgoing mails are delivered to the specified smarthost. (postfix option `default_transport`)
`smarthostport`: `<integer> (1 - 65535)` ('default =' `25`):: `smarthostport`: `<integer> (1 - 65535)` ('default =' `25`)::

2
pmg.spamquar-conf-opts.adoc
View File

@ -1,6 +1,6 @@
`allowhrefs`: `<boolean>` ('default =' `1`):: `allowhrefs`: `<boolean>` ('default =' `1`)::
Allow to view hyperlinks. Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.
`authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`):: `authmode`: `<ldap | ldapticket | ticket>` ('default =' `ticket`)::

2
pmg.virusquar-conf-opts.adoc
View File

@ -1,6 +1,6 @@
`allowhrefs`: `<boolean>` ('default =' `1`):: `allowhrefs`: `<boolean>` ('default =' `1`)::
Allow to view hyperlinks. Allow to view hyperlinks. When disabled hyperlinks will be displayed as plain-text.
`lifetime`: `<integer> (1 - N)` ('default =' `7`):: `lifetime`: `<integer> (1 - N)` ('default =' `7`)::

4
pmgconfig.1-synopsis.adoc
View File

@ -97,7 +97,7 @@ ACME challenge type.
ACME Plugin ID name ACME Plugin ID name
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | tencent | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | alviy | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ionos_cloud | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | limacity | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | omglol | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | technitium | tele3 | tencent | timeweb | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | west_cn | world4you | yandex360 | yc | zilore | zone | zoneedit | zonomi>` ::
API plugin name API plugin name
@ -149,7 +149,7 @@ Update ACME plugin configuration.
ACME Plugin ID name ACME Plugin ID name
`--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | tele3 | tencent | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` :: `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | alviy | anx | artfiles | arvan | aurora | autodns | aws | azion | azure | bookmyname | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnsexit | dnshome | dnsimple | dnsservices | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gcore | gd | geoscaling | googledomains | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ionos_cloud | ipv64 | ispconfig | jd | joker | kappernet | kas | kinghost | knot | la | leaseweb | lexicon | limacity | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | mythic_beasts | namecheap | namecom | namesilo | nanelo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | omglol | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rage4 | rcode0 | regru | scaleway | schlundtech | selectel | selfhost | servercow | simply | technitium | tele3 | tencent | timeweb | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | west_cn | world4you | yandex360 | yc | zilore | zone | zoneedit | zonomi>` ::
API plugin name API plugin name

2
pmgreport.1-synopsis.adoc
View File

@ -14,7 +14,7 @@ Debug mode. Print raw email to stdout instead of sending them.
`--receiver` `<string>` :: `--receiver` `<string>` ::
Send report to this email address. Default is the administratior email address. Send report to this email address. Default is the administrator email address.
`--timespan` `<today | yesterday>` ('default =' `today`):: `--timespan` `<today | yesterday>` ('default =' `today`)::