Skip to main content

ConfigureLetsEncryptRequest

domainstringrequired

Hostname the certificate will cover, challenged via DNS-01.

Possible values: non-empty

providerDNS01Providerrequired

DNS-01 providers in v1: Cloudflare's API and generic RFC 2136. HTTP-01 and TLS-ALPN-01 are not offered.

Possible values: [cloudflare, rfc2136]

cloudflareAPITokenstring

Cloudflare API token with Zone.DNS Edit. Write-only. Required when provider is cloudflare and no token is stored yet.

rfc2136Nameserverstring

RFC 2136 nameserver as host:port. Required when provider is rfc2136.

rfc2136TsigKeyNamestring

TSIG key name. Required when provider is rfc2136.

rfc2136TsigSecretstring

TSIG secret. Write-only. Required when provider is rfc2136 and no secret is stored yet.

rfc2136TsigAlgorithmstring

TSIG algorithm. Defaults to hmac-sha256.

ConfigureLetsEncryptRequest
{
  "domain": "string",
  "provider": "cloudflare",
  "cloudflareAPIToken": "string",
  "rfc2136Nameserver": "string",
  "rfc2136TsigKeyName": "string",
  "rfc2136TsigSecret": "string",
  "rfc2136TsigAlgorithm": "string"
}