v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/target-create-lets-encrypt

Request body

acme-challengestring
delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Description of the object

dns-target-credsstring

Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP, Cloudflare targets

dns-zonestring

Cloudflare DNS zone identifier. Required when dns-target-creds points to Cloudflare target

emailstring required

Email address for ACME account registration

gcp-projectstring

GCP Cloud DNS: Project ID. Optional - can be derived from service account

hosted-zonestring

AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target

jsonboolean

Set output format to JSON

keystring

The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)

lets-encrypt-urlstring
max-versionsstring

Set the maximum number of versions, limited by the account settings defaults.

namestring required

Target name

resource-groupstring

Azure resource group name. Required when dns-target-creds points to Azure target

timeoutstring
tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

targetCreateLetsEncryptResponse wraps response body.

target_idinteger