# acme.dns.authenticator.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: integer

##### Parameter 2: options

#### options

Type: object

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

##

#### 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

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

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

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

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

##

#### 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

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

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

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### DNSAuthenticatorEntry

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the DNS authenticator.

##

#### Attributes

Authentication credentials and configuration (masked for security).

## One of

#### CloudFlareSchema

Type: object
No Additional Properties

##

#### Authenticator

Type: const

DNS authenticator type identifier for Cloudflare.

Specific value: `"cloudflare"`

##

#### Cloudflare Email

Default: null

Cloudflare Email.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Api Key

Default: null

API Key.

## Any of

Type: string

Must be at least `1` characters long

Type: null

##

#### Api Token

Default: null

API Token.

## Any of

Type: string

Must be at least `1` characters long

Type: null

#### DigitalOceanSchema

Type: object
No Additional Properties

##

#### Authenticator

Type: const

DNS authenticator type identifier for DigitalOcean.

Specific value: `"digitalocean"`

##

#### Digitalocean Token

Type: string

DigitalOcean Token.

Must be at least `1` characters long

#### OVHSchema

Type: object
No Additional Properties

##

#### Authenticator

Type: const

DNS authenticator type identifier for OVH.

Specific value: `"OVH"`

##

#### Application Key

Type: string

OVH Application Key.

Must be at least `1` characters long

##

#### Application Secret

Type: string

OVH Application Secret.

Must be at least `1` characters long

##

#### Consumer Key

Type: string

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

##

#### Authenticator

Type: const

DNS authenticator type identifier for AWS Route 53.

Specific value: `"route53"`

##

#### Access Key Id

Type: string

AWS Access Key ID.

Must be at least `1` characters long

##

#### Secret Access Key

Type: string

AWS Secret Access Key.

Must be at least `1` characters long

#### ShellSchema

Type: object
No Additional Properties

##

#### Authenticator

Type: const

DNS authenticator type identifier for custom shell scripts.

Specific value: `"shell"`

##

#### Script

Type: string Format: file-path

Authentication Script.

##

#### User

Type: string Default: "nobody"

Running user.

Must be at least `1` characters long

##

#### Timeout

Type: integer Default: 60

Script Timeout.

Value must be greater or equal to `5`

##

#### Delay

Type: integer Default: 60

Propagation delay.

Value must be greater or equal to `10`

##

#### Name

Type: string

Human-readable name for the DNS authenticator.

Required roles: NETWORK_INTERFACE_READ