acme.dns.authenticator.update

Update DNS Authenticator of id

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

Parameter 2: dns_authenticator_update

dns_authenticator_update

Type: object
No Additional Properties

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

Return value

ACMEDNSAuthenticatorEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

attributes Required

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 Required

Name

Type: string

Required roles: NETWORK_INTERFACE_WRITE