proxmox-mirrors/pmg-docs
1
0
Fork 0
mirror of https://git.proxmox.com/git/pmg-docs synced 2025-07-09 20:01:51 +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 2023-03-24 10:28:58 +01:00
parent 8682cc5751
commit 8c3080657b
5 changed files with 164 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

154
api-viewer/apidata.js
View File

@ -7903,6 +7903,106 @@ var apiSchema = [
"path" : "/config/tlspolicy", "path" : "/config/tlspolicy",
"text" : "tlspolicy" "text" : "tlspolicy"
}, },
{
"children" : [
{
"info" : {
"DELETE" : {
"allowtoken" : 1,
"description" : "Delete a tls_inbound_domains entry",
"method" : "DELETE",
"name" : "delete",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"domain" : {
"description" : "Domain which should be removed from tls_inbound_domains",
"format" : "transport-domain",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"admin"
]
},
"protected" : 1,
"proxyto" : "master",
"returns" : {
"type" : "null"
}
}
},
"leaf" : 1,
"path" : "/config/tls-inbound-domains/{domain}",
"text" : "{domain}"
}
],
"info" : {
"GET" : {
"allowtoken" : 1,
"description" : "List tls_inbound_domains entries.",
"method" : "GET",
"name" : "index",
"parameters" : {
"additionalProperties" : 0
},
"permissions" : {
"check" : [
"admin",
"audit"
]
},
"proxyto" : "master",
"returns" : {
"description" : "List of domains for which TLS will be enforced on incoming connections",
"items" : {
"format" : "transport-domain",
"type" : "string"
},
"links" : [
{
"href" : "{domain}",
"rel" : "child"
}
],
"type" : "array"
}
},
"POST" : {
"allowtoken" : 1,
"description" : "Add new tls_inbound_domains entry.",
"method" : "POST",
"name" : "create",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"domain" : {
"description" : "Domain for which TLS should be enforced on incoming connections",
"format" : "transport-domain",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"admin"
]
},
"protected" : 1,
"proxyto" : "master",
"returns" : {
"type" : "null"
}
}
},
"leaf" : 0,
"path" : "/config/tls-inbound-domains",
"text" : "tls-inbound-domains"
},
{ {
"children" : [ "children" : [
{ {
@ -9086,20 +9186,24 @@ var apiSchema = [
"aws", "aws",
"azion", "azion",
"azure", "azure",
"bunny",
"cf", "cf",
"clouddns", "clouddns",
"cloudns", "cloudns",
"cn", "cn",
"conoha", "conoha",
"constellix", "constellix",
"cx", "cpanel",
"curanet",
"cyon", "cyon",
"da", "da",
"ddnss", "ddnss",
"desec", "desec",
"df", "df",
"dgon", "dgon",
"dnshome",
"dnsimple", "dnsimple",
"dnsservices",
"do", "do",
"doapi", "doapi",
"domeneshop", "domeneshop",
@ -9115,11 +9219,12 @@ var apiSchema = [
"edgedns", "edgedns",
"euserv", "euserv",
"exoscale", "exoscale",
"fornex",
"freedns", "freedns",
"gandi_livedns", "gandi_livedns",
"gcloud", "gcloud",
"gd", "gd",
"gdnsdk", "geoscaling",
"he", "he",
"hetzner", "hetzner",
"hexonet", "hexonet",
@ -9137,6 +9242,7 @@ var apiSchema = [
"kas", "kas",
"kinghost", "kinghost",
"knot", "knot",
"la",
"leaseweb", "leaseweb",
"lexicon", "lexicon",
"linode", "linode",
@ -9150,6 +9256,7 @@ var apiSchema = [
"myapi", "myapi",
"mydevil", "mydevil",
"mydnsjp", "mydnsjp",
"mythic_beasts",
"namecheap", "namecheap",
"namecom", "namecom",
"namesilo", "namesilo",
@ -9177,24 +9284,29 @@ var apiSchema = [
"porkbun", "porkbun",
"rackcorp", "rackcorp",
"rackspace", "rackspace",
"rage4",
"rcode0", "rcode0",
"regru", "regru",
"scaleway", "scaleway",
"schlundtech", "schlundtech",
"selectel", "selectel",
"selfhost",
"servercow", "servercow",
"simply", "simply",
"tele3", "tele3",
"transip", "transip",
"udr",
"ultra", "ultra",
"unoeuro", "unoeuro",
"variomedia", "variomedia",
"veesp", "veesp",
"vercel",
"vscale", "vscale",
"vultr", "vultr",
"websupport", "websupport",
"world4you", "world4you",
"yandex", "yandex",
"yc",
"zilore", "zilore",
"zone", "zone",
"zonomi" "zonomi"
@ -9340,20 +9452,24 @@ var apiSchema = [
"aws", "aws",
"azion", "azion",
"azure", "azure",
"bunny",
"cf", "cf",
"clouddns", "clouddns",
"cloudns", "cloudns",
"cn", "cn",
"conoha", "conoha",
"constellix", "constellix",
"cx", "cpanel",
"curanet",
"cyon", "cyon",
"da", "da",
"ddnss", "ddnss",
"desec", "desec",
"df", "df",
"dgon", "dgon",
"dnshome",
"dnsimple", "dnsimple",
"dnsservices",
"do", "do",
"doapi", "doapi",
"domeneshop", "domeneshop",
@ -9369,11 +9485,12 @@ var apiSchema = [
"edgedns", "edgedns",
"euserv", "euserv",
"exoscale", "exoscale",
"fornex",
"freedns", "freedns",
"gandi_livedns", "gandi_livedns",
"gcloud", "gcloud",
"gd", "gd",
"gdnsdk", "geoscaling",
"he", "he",
"hetzner", "hetzner",
"hexonet", "hexonet",
@ -9391,6 +9508,7 @@ var apiSchema = [
"kas", "kas",
"kinghost", "kinghost",
"knot", "knot",
"la",
"leaseweb", "leaseweb",
"lexicon", "lexicon",
"linode", "linode",
@ -9404,6 +9522,7 @@ var apiSchema = [
"myapi", "myapi",
"mydevil", "mydevil",
"mydnsjp", "mydnsjp",
"mythic_beasts",
"namecheap", "namecheap",
"namecom", "namecom",
"namesilo", "namesilo",
@ -9431,24 +9550,29 @@ var apiSchema = [
"porkbun", "porkbun",
"rackcorp", "rackcorp",
"rackspace", "rackspace",
"rage4",
"rcode0", "rcode0",
"regru", "regru",
"scaleway", "scaleway",
"schlundtech", "schlundtech",
"selectel", "selectel",
"selfhost",
"servercow", "servercow",
"simply", "simply",
"tele3", "tele3",
"transip", "transip",
"udr",
"ultra", "ultra",
"unoeuro", "unoeuro",
"variomedia", "variomedia",
"veesp", "veesp",
"vercel",
"vscale", "vscale",
"vultr", "vultr",
"websupport", "websupport",
"world4you", "world4you",
"yandex", "yandex",
"yc",
"zilore", "zilore",
"zone", "zone",
"zonomi" "zonomi"
@ -9935,10 +10059,10 @@ var apiSchema = [
"delete" : { "delete" : {
"description" : "A list of settings you want to delete.", "description" : "A list of settings you want to delete.",
"enum" : [ "enum" : [
"rp",
"id", "id",
"origin", "origin",
"allow-subdomains", "allow-subdomains"
"rp"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"
@ -10589,6 +10713,13 @@ var apiSchema = [
"type" : "integer", "type" : "integer",
"typetext" : "<integer> (1 - 65535)" "typetext" : "<integer> (1 - 65535)"
}, },
"smtputf8" : {
"default" : 1,
"description" : "Enable SMTPUTF8 support in Postfix and detection for locally generated mail",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"spf" : { "spf" : {
"default" : 1, "default" : 1,
"description" : "Use Sender Policy Framework.", "description" : "Use Sender Policy Framework.",
@ -10707,6 +10838,13 @@ var apiSchema = [
"type" : "string", "type" : "string",
"typetext" : "<string>" "typetext" : "<string>"
}, },
"extract_text" : {
"default" : 0,
"description" : "Extract text from attachments (doc, pdf, rtf, images) and scan for spam.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"languages" : { "languages" : {
"default" : "all", "default" : "all",
"description" : "This option is used to specify which languages are considered OK for incoming mail.", "description" : "This option is used to specify which languages are considered OK for incoming mail.",
@ -17644,9 +17782,9 @@ var apiSchema = [
"default" : "spam", "default" : "spam",
"description" : "Query this type of quarantine for users.", "description" : "Query this type of quarantine for users.",
"enum" : [ "enum" : [
"attachment",
"virus", "virus",
"spam" "spam",
"attachment"
], ],
"optional" : 1, "optional" : 1,
"type" : "string" "type" : "string"

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

@ -212,6 +212,10 @@ When set, all outgoing mails are deliverd to the specified smarthost.
SMTP port number for smarthost. SMTP port number for smarthost.
`smtputf8`: `<boolean>` ('default =' `1`)::
Enable SMTPUTF8 support in Postfix and detection for locally generated mail
`spf`: `<boolean>` ('default =' `1`):: `spf`: `<boolean>` ('default =' `1`)::
Use Sender Policy Framework. Use Sender Policy Framework.
@ -242,6 +246,10 @@ Additional score for bounce mails.
Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...). Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...).
`extract_text`: `<boolean>` ('default =' `0`)::
Extract text from attachments (doc, pdf, rtf, images) and scan for spam.
`languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`):: `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
This option is used to specify which languages are considered OK for incoming mail. This option is used to specify which languages are considered OK for incoming mail.

4
pmg.mail-options-conf-opts.adoc
View File

@ -70,6 +70,10 @@ Reject unknown clients.
Reject unknown senders. Reject unknown senders.
`smtputf8`: `<boolean>` ('default =' `1`)::
Enable SMTPUTF8 support in Postfix and detection for locally generated mail
`spf`: `<boolean>` ('default =' `1`):: `spf`: `<boolean>` ('default =' `1`)::
Use Sender Policy Framework. Use Sender Policy Framework.

4
pmg.spam-conf-opts.adoc
View File

@ -6,6 +6,10 @@ Additional score for bounce mails.
Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...). Score for ClamAV heuristics (Encrypted Archives/Documents, PhishingScanURLs, ...).
`extract_text`: `<boolean>` ('default =' `0`)::
Extract text from attachments (doc, pdf, rtf, images) and scan for spam.
`languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`):: `languages`: `(all|([a-z][a-z])+( ([a-z][a-z])+)*)` ('default =' `all`)::
This option is used to specify which languages are considered OK for incoming mail. This option is used to specify which languages are considered OK for incoming mail.

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 | arvan | aurora | autodns | aws | azion | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` :: `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | 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 | 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 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | 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 | arvan | aurora | autodns | aws | azion | azure | cf | clouddns | cloudns | cn | conoha | constellix | cx | cyon | da | ddnss | desec | df | dgon | dnsimple | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | freedns | gandi_livedns | gcloud | gd | gdnsdk | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | ispconfig | jd | joker | kappernet | kas | kinghost | knot | leaseweb | lexicon | linode | linode_v4 | loopia | lua | maradns | me | miab | misaka | myapi | mydevil | mydnsjp | namecheap | namecom | namesilo | nederhost | neodigit | netcup | netlify | nic | njalla | nm | nsd | nsone | nsupdate | nw | oci | one | online | openprovider | openstack | opnsense | ovh | pdns | pleskxml | pointhq | porkbun | rackcorp | rackspace | rcode0 | regru | scaleway | schlundtech | selectel | servercow | simply | tele3 | transip | ultra | unoeuro | variomedia | veesp | vscale | vultr | websupport | world4you | yandex | zilore | zone | zonomi>` :: `--api` `<1984hosting | acmedns | acmeproxy | active24 | ad | ali | anx | arvan | aurora | autodns | aws | azion | azure | bunny | cf | clouddns | cloudns | cn | conoha | constellix | cpanel | curanet | cyon | da | ddnss | desec | df | dgon | dnshome | dnsimple | dnsservices | do | doapi | domeneshop | dp | dpi | dreamhost | duckdns | durabledns | dyn | dynu | dynv6 | easydns | edgedns | euserv | exoscale | fornex | freedns | gandi_livedns | gcloud | gd | geoscaling | he | hetzner | hexonet | hostingde | huaweicloud | infoblox | infomaniak | internetbs | inwx | ionos | 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 | 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 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
API plugin name API plugin name