acme.dns.authenticator.query

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

Each item of this array must be:

Type: object

Examples:

[
    [
        "name",
        "=",
        "bob"
    ]
]

[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]

Parameter 2: options

options

Type: object

Default:

{ "relationships": true, "extend": null, "extend_fk": [], "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options customize the results returned by a query method. More complete documentation with examples
are covered in the "Query methods" section of the TrueNAS API documentation.

No Additional Properties

relationships

Relationships

Type: boolean Default: true

extend

Extend

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extend_fk

Extend Fk

Type: array of string Default: []
No Additional Items

Each item of this array must be:

Type: string

extend_context

Extend Context

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

prefix

Prefix

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

extra

Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
query method.

order_by

Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may
also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
any null values at the head of the results list), nulls_last: (place any null values at the tail of the
results list).

No Additional Items

Each item of this array must be:

Type: string

Example:

[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]

select

Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character .
may be used to explicitly select only subkeys of the query result.

No Additional Items

Each item of this array must be:

Any of

• Option 1
• Option 2

Type: string

Type: array
No Additional Items

Each item of this array must be:

Type: object

Example:

[
    "username",
    "Authentication.status"
]

count

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

get

Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified query-filters. The query fails
if there specified query-filters return no results.

offset

Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the limit query-option
it may be used to implement pagination of large results arrays. WARNING: some query methods provide
volatile results and the onus is on the developer to understand whether pagination is appropriate
for a particular query API method.

limit

Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified query-filters to return. When
combined wtih the offset query-option it may be used to implement pagination of large results arrays.
WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
pagination is appropriate for a particular query API method.

force_sql_filters

Force Sql Filters

Type: boolean Default: false

Return value

Result

Any of

• Option 1
• ACMEDNSAuthenticatorQueryResultItem
• Option 3

Type: array of object
No Additional Items

Each item of this array must be:

ACMEDNSAuthenticatorQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

attributes

Attributes

One of

• CloudFlareSchema
• DigitalOceanSchema
• OVHSchema
• Route53Schema
• ShellSchema

CloudFlareSchema

Type: object
No Additional Properties

authenticator Required

Authenticator

Type: const

Must be one of:

• "cloudflare"

Specific value: "cloudflare"

cloudflare_email

Cloudflare Email

Default: null

Cloudflare Email

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

api_key

Api Key

Default: null

API Key

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

api_token

Api Token

Default: null

API Token

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

DigitalOceanSchema

Type: object
No Additional Properties

authenticator Required

Authenticator

Type: const

Must be one of:

• "digitalocean"

Specific value: "digitalocean"

digitalocean_token Required

Digitalocean Token

Type: string

DigitalOcean Token

Must be at least 1 characters long

OVHSchema

Type: object
No Additional Properties

authenticator Required

Authenticator

Type: const

Must be one of:

• "OVH"

Specific value: "OVH"

application_key Required

Application Key

Type: string

OVH Application Key

Must be at least 1 characters long

application_secret Required

Application Secret

Type: string

OVH Application Secret

Must be at least 1 characters long

consumer_key Required

Consumer Key

Type: string

OVH Consumer Key

Must be at least 1 characters long

endpoint Required

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: object
No Additional Properties

authenticator Required

Authenticator

Type: const

Must be one of:

• "route53"

Specific value: "route53"

access_key_id Required

Access Key Id

Type: string

AWS Access Key ID

Must be at least 1 characters long

secret_access_key Required

Secret Access Key

Type: string

AWS Secret Access Key

Must be at least 1 characters long

ShellSchema

Type: object
No Additional Properties

authenticator Required

Authenticator

Type: const

Must be one of:

• "shell"

Specific value: "shell"

script Required

Script

Type: stringFormat: file-path

Authentication Script

user

User

Type: string Default: "nobody"

Running user

Must be at least 1 characters long

timeout

Timeout

Type: integer Default: 60

Script Timeout

Value must be greater or equal to 5

delay

Delay

Type: integer Default: 60

Propagation delay

Value must be greater or equal to 10

name

Name

Type: string

ACMEDNSAuthenticatorQueryResultItem

Type: object
No Additional Properties

id

Id

Type: integer

attributes

Attributes

One of

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5

Type: object

Type: object

Type: object

Type: object

Type: object

name

Name

Type: string

Type: integer

Required roles: NETWORK_INTERFACE_READ