acme.dns.authenticator.query¶
Type: object
No Additional Properties
Type: array
No Additional Items
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Items
Tuple Validation
Parameter 1: filters
filters
Type: array Default: []No Additional Items
Each item of this array must be:
Type: object
Parameter 2: options
options
Type: objectDefault:
{
"relationships": true,
"extend": null,
"extend_context": null,
"prefix": null,
"extra": {},
"order_by": [],
"select": [],
"count": false,
"get": false,
"offset": 0,
"limit": 0,
"force_sql_filters": false
}
No Additional Properties
Relationships
Type: boolean Default: trueExtend
Default: null Type: string
Type: null
Extend Context
Default: null Type: string
Type: null
Prefix
Default: null Type: string
Type: null
Extra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Select
Type: array Default: []No Additional Items
Each item of this array must be:
Type: string
Type: array
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseResult
Type: array of object
No Additional Items
No Additional Properties
No Additional Properties
Specific value:
No Additional Properties
Specific value:
No Additional Properties
Specific value:
No Additional Properties
Specific value:
No Additional Properties
Specific value:
No Additional Items
Each item of this array must be:
ACMEDNSAuthenticatorQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerAttributes
CloudFlareSchema
Type: objectNo Additional Properties
Authenticator
Type: constMust be one of:
- "cloudflare"
"cloudflare"
Cloudflare Email
Default: nullCloudflare Email
Type: string
Must be at least 1
characters long
Type: null
Api Key
Default: nullAPI Key
Type: string
Must be at least 1
characters long
Type: null
Api Token
Default: nullAPI Token
Type: string
Must be at least 1
characters long
Type: null
DigitalOceanSchema
Type: objectNo Additional Properties
Authenticator
Type: constMust be one of:
- "digitalocean"
"digitalocean"
Digitalocean Token
Type: stringDigitalOcean Token
Must be at least 1
characters long
OVHSchema
Type: objectNo Additional Properties
Authenticator
Type: constMust be one of:
- "OVH"
"OVH"
Application Key
Type: string Default: "*"OVH Application Key
Must be at least 1
characters long
Application Secret
Type: string Default: "*"OVH Application Secret
Must be at least 1
characters long
Consumer Key
Type: string Default: "*"OVH Consumer Key
Must be at least 1
characters long
Endpoint
Type: enum (of string)OVH Endpoint
Must be one of:
- "ovh-eu"
- "ovh-ca"
- "ovh-us"
- "kimsufi-eu"
- "kimsufi-ca"
- "soyoustart-eu"
- "soyoustart-ca"
Route53Schema
Type: objectNo Additional Properties
Authenticator
Type: constMust be one of:
- "route53"
"route53"
Access Key Id
Type: string Default: "*"AWS Access Key ID
Must be at least 1
characters long
Secret Access Key
Type: string Default: "*"AWS Secret Access Key
Must be at least 1
characters long
ShellSchema
Type: objectNo Additional Properties
Authenticator
Type: constMust be one of:
- "shell"
"shell"
Script
Type: stringFormat: file-pathAuthentication Script
User
Type: string Default: "nobody"Running user
Must be at least 1
characters long
Timeout
Type: integer Default: 60Script Timeout
Value must be greater or equal to 5
Delay
Type: integer Default: 60Propagation delay
Value must be greater or equal to 10
Name
Type: stringACMEDNSAuthenticatorQueryResultItem
Type: objectNo Additional Properties
Id
Type: integerAttributes
Type: object
Type: object
Type: object
Type: object
Type: object
Name
Type: string Type: integer
Required roles: NETWORK_INTERFACE_READ