mirror of
https://git.proxmox.com/git/pmg-docs
synced 2025-06-14 15:05:48 +00:00
update static schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht
parent
fc3a8a4593
commit
cbd73e8fd4
@ -99,6 +99,20 @@ var apiSchema = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 2)"
|
||||
},
|
||||
"from-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine FROM group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"from-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert FROM group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"id" : {
|
||||
"description" : "Rule ID.",
|
||||
"type" : "integer",
|
||||
@ -111,12 +125,54 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"priority" : {
|
||||
"description" : "Rule priotity.",
|
||||
"description" : "Rule priority.",
|
||||
"maximum" : 100,
|
||||
"minimum" : 0,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 100)"
|
||||
},
|
||||
"to-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine TO group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"to-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert TO group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"what-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine WHAT group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"what-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert WHAT group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"when-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine WHEN group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"when-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert WHEN group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -825,17 +881,73 @@ var apiSchema = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 2)"
|
||||
},
|
||||
"from-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine FROM group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"from-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert FROM group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Rule name",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"priority" : {
|
||||
"description" : "Rule priotity.",
|
||||
"description" : "Rule priority.",
|
||||
"maximum" : 100,
|
||||
"minimum" : 0,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (0 - 100)"
|
||||
},
|
||||
"to-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine TO group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"to-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert TO group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"what-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine WHAT group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"what-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert WHAT group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"when-and" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to 'and' combine WHEN group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"when-invert" : {
|
||||
"default" : 0,
|
||||
"description" : "Flag to invert WHEN group matches.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -1784,6 +1896,13 @@ var apiSchema = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"and" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, objects in this group are 'and' combined.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"info" : {
|
||||
"description" : "Informational comment.",
|
||||
"maxLength" : 255,
|
||||
@ -1791,6 +1910,13 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"invert" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, the resulting match is inverted.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Group name.",
|
||||
"maxLength" : 255,
|
||||
@ -2871,6 +2997,13 @@ var apiSchema = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"and" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, objects in this group are 'and' combined.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"info" : {
|
||||
"description" : "Informational comment.",
|
||||
"maxLength" : 255,
|
||||
@ -2878,6 +3011,13 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"invert" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, the resulting match is inverted.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Group name.",
|
||||
"maxLength" : 255,
|
||||
@ -2953,6 +3093,13 @@ var apiSchema = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"and" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, objects in this group are 'and' combined.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"info" : {
|
||||
"description" : "Informational comment.",
|
||||
"maxLength" : 255,
|
||||
@ -2960,6 +3107,13 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"invert" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, the resulting match is inverted.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Group name.",
|
||||
"maxLength" : 255,
|
||||
@ -3316,6 +3470,13 @@ var apiSchema = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"and" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, objects in this group are 'and' combined.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"info" : {
|
||||
"description" : "Informational comment.",
|
||||
"maxLength" : 255,
|
||||
@ -3323,6 +3484,13 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"invert" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, the resulting match is inverted.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Group name.",
|
||||
"maxLength" : 255,
|
||||
@ -3398,6 +3566,13 @@ var apiSchema = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"and" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, objects in this group are 'and' combined.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"info" : {
|
||||
"description" : "Informational comment.",
|
||||
"maxLength" : 255,
|
||||
@ -3405,6 +3580,13 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"invert" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, the resulting match is inverted.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Group name.",
|
||||
"maxLength" : 255,
|
||||
@ -4535,6 +4717,13 @@ var apiSchema = [
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"and" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, objects in this group are 'and' combined.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"info" : {
|
||||
"description" : "Informational comment.",
|
||||
"maxLength" : 255,
|
||||
@ -4542,6 +4731,13 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"invert" : {
|
||||
"default" : 0,
|
||||
"description" : "If set to 1, the resulting match is inverted.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean",
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"name" : {
|
||||
"description" : "Group name.",
|
||||
"maxLength" : 255,
|
||||
@ -5678,8 +5874,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -8353,8 +8549,8 @@ var apiSchema = [
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -8424,8 +8620,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -8498,8 +8694,8 @@ var apiSchema = [
|
||||
"type" : "string"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
@ -8541,8 +8737,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -8574,8 +8770,8 @@ var apiSchema = [
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -8684,8 +8880,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -8779,6 +8975,15 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"port" : {
|
||||
"default" : 8007,
|
||||
"description" : "Non-default port for Proxmox Backup Server.",
|
||||
"maximum" : 65535,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (1 - 65535)"
|
||||
},
|
||||
"remote" : {
|
||||
"description" : "Proxmox Backup Server ID.",
|
||||
"format" : "pve-configid",
|
||||
@ -8928,6 +9133,14 @@ var apiSchema = [
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"port" : {
|
||||
"default" : 8007,
|
||||
"description" : "Non-default port for Proxmox Backup Server.",
|
||||
"maximum" : 65535,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"remote" : {
|
||||
"description" : "Proxmox Backup Server ID.",
|
||||
"format" : "pve-configid",
|
||||
@ -9063,6 +9276,15 @@ var apiSchema = [
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"port" : {
|
||||
"default" : 8007,
|
||||
"description" : "Non-default port for Proxmox Backup Server.",
|
||||
"maximum" : 65535,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (1 - 65535)"
|
||||
},
|
||||
"remote" : {
|
||||
"description" : "Proxmox Backup Server ID.",
|
||||
"format" : "pve-configid",
|
||||
@ -9180,12 +9402,14 @@ var apiSchema = [
|
||||
"ad",
|
||||
"ali",
|
||||
"anx",
|
||||
"artfiles",
|
||||
"arvan",
|
||||
"aurora",
|
||||
"autodns",
|
||||
"aws",
|
||||
"azion",
|
||||
"azure",
|
||||
"bookmyname",
|
||||
"bunny",
|
||||
"cf",
|
||||
"clouddns",
|
||||
@ -9201,6 +9425,7 @@ var apiSchema = [
|
||||
"desec",
|
||||
"df",
|
||||
"dgon",
|
||||
"dnsexit",
|
||||
"dnshome",
|
||||
"dnsimple",
|
||||
"dnsservices",
|
||||
@ -9298,6 +9523,7 @@ var apiSchema = [
|
||||
"servercow",
|
||||
"simply",
|
||||
"tele3",
|
||||
"tencent",
|
||||
"transip",
|
||||
"udr",
|
||||
"ultra",
|
||||
@ -9333,8 +9559,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -9450,12 +9676,14 @@ var apiSchema = [
|
||||
"ad",
|
||||
"ali",
|
||||
"anx",
|
||||
"artfiles",
|
||||
"arvan",
|
||||
"aurora",
|
||||
"autodns",
|
||||
"aws",
|
||||
"azion",
|
||||
"azure",
|
||||
"bookmyname",
|
||||
"bunny",
|
||||
"cf",
|
||||
"clouddns",
|
||||
@ -9471,6 +9699,7 @@ var apiSchema = [
|
||||
"desec",
|
||||
"df",
|
||||
"dgon",
|
||||
"dnsexit",
|
||||
"dnshome",
|
||||
"dnsimple",
|
||||
"dnsservices",
|
||||
@ -9568,6 +9797,7 @@ var apiSchema = [
|
||||
"servercow",
|
||||
"simply",
|
||||
"tele3",
|
||||
"tencent",
|
||||
"transip",
|
||||
"udr",
|
||||
"ultra",
|
||||
@ -9830,6 +10060,20 @@ var apiSchema = [
|
||||
"pattern" : "^https?://.*",
|
||||
"type" : "string"
|
||||
},
|
||||
"eab-hmac-key" : {
|
||||
"description" : "HMAC key for External Account Binding.",
|
||||
"optional" : 1,
|
||||
"requires" : "eab-kid",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"eab-kid" : {
|
||||
"description" : "Key Identifier for External Account Binding.",
|
||||
"optional" : 1,
|
||||
"requires" : "eab-hmac-key",
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"name" : {
|
||||
"default" : "default",
|
||||
"description" : "ACME account config file name.",
|
||||
@ -9867,7 +10111,7 @@ var apiSchema = [
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Retrieve ACME TermsOfService URL from CA.",
|
||||
"description" : "Retrieve ACME TermsOfService URL from CA. Deprecated, please use /config/acme/meta.",
|
||||
"method" : "GET",
|
||||
"name" : "get_tos",
|
||||
"parameters" : {
|
||||
@ -9896,6 +10140,63 @@ var apiSchema = [
|
||||
"path" : "/config/acme/tos",
|
||||
"text" : "tos"
|
||||
},
|
||||
{
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Retrieve ACME Directory Meta Information",
|
||||
"method" : "GET",
|
||||
"name" : "get_meta",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"directory" : {
|
||||
"default" : "https://acme-v02.api.letsencrypt.org/directory",
|
||||
"description" : "URL of ACME CA directory endpoint.",
|
||||
"optional" : 1,
|
||||
"pattern" : "^https?://.*",
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"user" : "all"
|
||||
},
|
||||
"returns" : {
|
||||
"additionalProperties" : 1,
|
||||
"properties" : {
|
||||
"caaIdentities" : {
|
||||
"description" : "Hostnames referring to the ACME servers.",
|
||||
"items" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"optional" : 1,
|
||||
"type" : "array"
|
||||
},
|
||||
"externalAccountRequired" : {
|
||||
"description" : "EAB Required",
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
},
|
||||
"termsOfService" : {
|
||||
"description" : "ACME TermsOfService URL.",
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"website" : {
|
||||
"description" : "URL to more information about the ACME server.",
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
}
|
||||
},
|
||||
"type" : "object"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/config/acme/meta",
|
||||
"text" : "meta"
|
||||
},
|
||||
{
|
||||
"info" : {
|
||||
"GET" : {
|
||||
@ -10067,10 +10368,10 @@ var apiSchema = [
|
||||
"delete" : {
|
||||
"description" : "A list of settings you want to delete.",
|
||||
"enum" : [
|
||||
"origin",
|
||||
"id",
|
||||
"allow-subdomains",
|
||||
"rp",
|
||||
"id"
|
||||
"origin"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
@ -10239,8 +10540,8 @@ var apiSchema = [
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -10383,8 +10684,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -10507,8 +10808,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -10545,6 +10846,15 @@ var apiSchema = [
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (1 - 65535)"
|
||||
},
|
||||
"filter-timeout" : {
|
||||
"default" : 600,
|
||||
"description" : "Timeout for the processing of one mail (in seconds) (postfix option `smtpd_proxy_timeout` and `lmtp_data_done_timeout`)",
|
||||
"maximum" : 86400,
|
||||
"minimum" : 2,
|
||||
"optional" : 1,
|
||||
"type" : "integer",
|
||||
"typetext" : "<integer> (2 - 86400)"
|
||||
},
|
||||
"greylist" : {
|
||||
"default" : 1,
|
||||
"description" : "Use Greylisting for IPv4.",
|
||||
@ -10601,7 +10911,7 @@ var apiSchema = [
|
||||
"typetext" : "<integer> (1 - 65535)"
|
||||
},
|
||||
"max_filters" : {
|
||||
"default" : 15,
|
||||
"default" : 25,
|
||||
"description" : "Maximum number of pmg-smtp-filter processes.",
|
||||
"maximum" : 40,
|
||||
"minimum" : 3,
|
||||
@ -10619,7 +10929,7 @@ var apiSchema = [
|
||||
"typetext" : "<integer> (2 - 10)"
|
||||
},
|
||||
"max_smtpd_in" : {
|
||||
"default" : 97,
|
||||
"default" : 100,
|
||||
"description" : "Maximum number of SMTP daemon processes (in).",
|
||||
"maximum" : 100,
|
||||
"minimum" : 3,
|
||||
@ -10628,7 +10938,7 @@ var apiSchema = [
|
||||
"typetext" : "<integer> (3 - 100)"
|
||||
},
|
||||
"max_smtpd_out" : {
|
||||
"default" : 97,
|
||||
"default" : 100,
|
||||
"description" : "Maximum number of SMTP daemon processes (out).",
|
||||
"maximum" : 100,
|
||||
"minimum" : 3,
|
||||
@ -10758,7 +11068,7 @@ var apiSchema = [
|
||||
"typetext" : "<boolean>"
|
||||
},
|
||||
"verifyreceivers" : {
|
||||
"description" : "Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)",
|
||||
"description" : "Enable receiver verification. The value specifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)",
|
||||
"enum" : [
|
||||
"450",
|
||||
"550"
|
||||
@ -10841,8 +11151,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -10978,8 +11288,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -11114,8 +11424,8 @@ var apiSchema = [
|
||||
"typetext" : "<string>"
|
||||
},
|
||||
"digest" : {
|
||||
"description" : "Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 40,
|
||||
"description" : "Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.",
|
||||
"maxLength" : 64,
|
||||
"optional" : 1,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
@ -15172,6 +15482,14 @@ var apiSchema = [
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
},
|
||||
"port" : {
|
||||
"default" : 8007,
|
||||
"description" : "Non-default port for Proxmox Backup Server.",
|
||||
"maximum" : 65535,
|
||||
"minimum" : 1,
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"remote" : {
|
||||
"description" : "Proxmox Backup Server ID.",
|
||||
"format" : "pve-configid",
|
||||
@ -16621,6 +16939,43 @@ var apiSchema = [
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
"children" : [
|
||||
{
|
||||
"info" : {
|
||||
"PUT" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Unlock a user's TFA authentication.",
|
||||
"method" : "PUT",
|
||||
"name" : "unlock_tfa",
|
||||
"parameters" : {
|
||||
"additionalProperties" : 0,
|
||||
"properties" : {
|
||||
"userid" : {
|
||||
"description" : "User ID",
|
||||
"format" : "pmg-userid",
|
||||
"maxLength" : 64,
|
||||
"minLength" : 4,
|
||||
"type" : "string",
|
||||
"typetext" : "<string>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"permissions" : {
|
||||
"check" : [
|
||||
"admin"
|
||||
]
|
||||
},
|
||||
"protected" : 1,
|
||||
"returns" : {
|
||||
"type" : "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"path" : "/access/users/{userid}/unlock-tfa",
|
||||
"text" : "unlock-tfa"
|
||||
}
|
||||
],
|
||||
"info" : {
|
||||
"DELETE" : {
|
||||
"allowtoken" : 1,
|
||||
@ -16785,7 +17140,7 @@ var apiSchema = [
|
||||
}
|
||||
}
|
||||
},
|
||||
"leaf" : 1,
|
||||
"leaf" : 0,
|
||||
"path" : "/access/users/{userid}",
|
||||
"text" : "{userid}"
|
||||
}
|
||||
@ -16821,6 +17176,16 @@ var apiSchema = [
|
||||
"role" : {
|
||||
"type" : "string"
|
||||
},
|
||||
"tfa-locked-until" : {
|
||||
"description" : "Contains a timestamp until when a user is locked out of 2nd factors.",
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"totp-locked" : {
|
||||
"description" : "True if the user is currently locked out of TOTP factors.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
},
|
||||
"userid" : {
|
||||
"type" : "string"
|
||||
}
|
||||
@ -17339,6 +17704,16 @@ var apiSchema = [
|
||||
},
|
||||
"type" : "array"
|
||||
},
|
||||
"tfa-locked-until" : {
|
||||
"description" : "Contains a timestamp until when a user is locked out of 2nd factors.",
|
||||
"optional" : 1,
|
||||
"type" : "integer"
|
||||
},
|
||||
"totp-locked" : {
|
||||
"description" : "True if the user is currently locked out of TOTP factors.",
|
||||
"optional" : 1,
|
||||
"type" : "boolean"
|
||||
},
|
||||
"userid" : {
|
||||
"description" : "User this entry belongs to.",
|
||||
"type" : "string"
|
||||
@ -17358,7 +17733,7 @@ var apiSchema = [
|
||||
"info" : {
|
||||
"GET" : {
|
||||
"allowtoken" : 1,
|
||||
"description" : "Dummy. Useful for formaters which want to priovde a login page.",
|
||||
"description" : "Dummy. Useful for formatters which want to priovde a login page.",
|
||||
"method" : "GET",
|
||||
"name" : "get_ticket",
|
||||
"parameters" : {
|
||||
@ -17791,9 +18166,9 @@ var apiSchema = [
|
||||
"default" : "spam",
|
||||
"description" : "Query this type of quarantine for users.",
|
||||
"enum" : [
|
||||
"virus",
|
||||
"attachment",
|
||||
"spam",
|
||||
"virus"
|
||||
"spam"
|
||||
],
|
||||
"optional" : 1,
|
||||
"type" : "string"
|
||||
|
||||
@ -128,6 +128,10 @@ SMTP delay warning time (in hours). (postfix option `delay_warning_time`)
|
||||
|
||||
SMTP port number for incoming mail (untrusted). This must be a different number than 'int_port'.
|
||||
|
||||
`filter-timeout`: `<integer> (2 - 86400)` ('default =' `600`)::
|
||||
|
||||
Timeout for the processing of one mail (in seconds) (postfix option `smtpd_proxy_timeout` and `lmtp_data_done_timeout`)
|
||||
|
||||
`greylist`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Use Greylisting for IPv4.
|
||||
@ -156,7 +160,7 @@ Hide received header in outgoing mails.
|
||||
|
||||
SMTP port number for outgoing mail (trusted).
|
||||
|
||||
`max_filters`: `<integer> (3 - 40)` ('default =' `15`)::
|
||||
`max_filters`: `<integer> (3 - 40)` ('default =' `25`)::
|
||||
|
||||
Maximum number of pmg-smtp-filter processes.
|
||||
|
||||
@ -164,11 +168,11 @@ Maximum number of pmg-smtp-filter processes.
|
||||
|
||||
Maximum number of pmgpolicy processes.
|
||||
|
||||
`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `97`)::
|
||||
`max_smtpd_in`: `<integer> (3 - 100)` ('default =' `100`)::
|
||||
|
||||
Maximum number of SMTP daemon processes (in).
|
||||
|
||||
`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `97`)::
|
||||
`max_smtpd_out`: `<integer> (3 - 100)` ('default =' `100`)::
|
||||
|
||||
Maximum number of SMTP daemon processes (out).
|
||||
|
||||
@ -238,7 +242,7 @@ Enable TLS Logging.
|
||||
|
||||
`verifyreceivers`: `<450 | 550>` ::
|
||||
|
||||
Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)
|
||||
Enable receiver verification. The value specifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)
|
||||
|
||||
.Section 'spam'
|
||||
|
||||
|
||||
@ -26,6 +26,10 @@ The inclusive lower bound for blocking a remote SMTP client, based on its combin
|
||||
|
||||
SMTP delay warning time (in hours). (postfix option `delay_warning_time`)
|
||||
|
||||
`filter-timeout`: `<integer> (2 - 86400)` ('default =' `600`)::
|
||||
|
||||
Timeout for the processing of one mail (in seconds) (postfix option `smtpd_proxy_timeout` and `lmtp_data_done_timeout`)
|
||||
|
||||
`greylist`: `<boolean>` ('default =' `1`)::
|
||||
|
||||
Use Greylisting for IPv4.
|
||||
@ -80,5 +84,5 @@ Use Sender Policy Framework.
|
||||
|
||||
`verifyreceivers`: `<450 | 550>` ::
|
||||
|
||||
Enable receiver verification. The value spefifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)
|
||||
Enable receiver verification. The value specifies the numerical reply code when the Postfix SMTP server rejects a recipient address. (postfix options `reject_unknown_recipient_domain`, `reject_unverified_recipient`, and `unverified_recipient_reject_code`)
|
||||
|
||||
|
||||
@ -160,6 +160,10 @@ Specify when to notify via e-mail
|
||||
|
||||
Password or API token secret for the user on the Proxmox Backup Server.
|
||||
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
|
||||
Non-default port for Proxmox Backup Server.
|
||||
|
||||
`--server` `<string>` ::
|
||||
|
||||
Proxmox Backup Server address.
|
||||
@ -198,7 +202,7 @@ A list of settings you want to delete.
|
||||
|
||||
`--digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--disable` `<boolean>` ::
|
||||
|
||||
@ -248,6 +252,10 @@ Specify when to notify via e-mail
|
||||
|
||||
Password or API token secret for the user on the Proxmox Backup Server.
|
||||
|
||||
`--port` `<integer> (1 - 65535)` ('default =' `8007`)::
|
||||
|
||||
Non-default port for Proxmox Backup Server.
|
||||
|
||||
`--server` `<string>` ::
|
||||
|
||||
Proxmox Backup Server address.
|
||||
|
||||
@ -97,7 +97,7 @@ ACME challenge type.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--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 | 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 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
|
||||
`--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 plugin name
|
||||
|
||||
@ -149,7 +149,7 @@ Update ACME plugin configuration.
|
||||
|
||||
ACME Plugin ID name
|
||||
|
||||
`--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 | 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 | transip | udr | ultra | unoeuro | variomedia | veesp | vercel | vscale | vultr | websupport | world4you | yandex | yc | zilore | zone | zonomi>` ::
|
||||
`--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 plugin name
|
||||
|
||||
@ -163,7 +163,7 @@ A list of settings you want to delete.
|
||||
|
||||
`--digest` `<string>` ::
|
||||
|
||||
Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.
|
||||
Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.
|
||||
|
||||
`--disable` `<boolean>` ::
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user