/target-create-lets-encrypt

post

https://api.akeyless.io/target-create-lets-encrypt

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

targetCreateLetsEncrypt is a command that creates a new Let's Encrypt target

acme-challenge

string

Defaults to http

delete_protection

string

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

description

string

Description of the object

dns-propagation-wait

string

Fixed wait after TXT publish (e.g. 30s, 2m). If omitted with pre-check on, no extra sleep (polling only). If omitted with --dns-skip-precheck, gateway uses 30s. DNS challenge only

dns-resolvers

array of strings

Custom DNS resolvers (ip:port) for DNS-01. Repeat for multiple. If omitted, Lego uses /etc/resolv.conf or Google Public DNS. DNS challenge only

dns-resolvers

dns-skip-precheck

boolean

Skip DNS TXT pre-check before CA validation. If --dns-propagation-wait is omitted and this flag is set, gateway waits 30s before CA validation. DNS challenge only

dns-target-creds

string

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

dns-timeout

string

Per-query DNS lookup timeout during pre-check (e.g. 10s), not total poll time. If omitted with pre-check on, Lego library default applies (10s per query on Linux). Ignored when --dns-skip-precheck is set. DNS challenge only

dns-zone

string

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

string

required

Email address for ACME account registration

gcp-project

string

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

hosted-zone

string

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

json

boolean

Defaults to false

Set output format to JSON

key

string

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

string

Defaults to production

lock-on-read

string

Lock this secret after each successful value read

lock-ttl

string

Lock TTL in minutes

max-versions

string

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

name

string

required

Target name

resource-group

string

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

rotate-on-unlock

string

Rotate this secret after it is unlocked

timeout

string

Defaults to 5m

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

Responses

201targetCreateLetsEncryptResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.