Domains

Create a new domain

Creates a new domain and automatically requests a Let's Encrypt challenge. You can specify the challenge type (HTTP-01 or DNS-01) in the request.

  • HTTP-01: Validates domain ownership by placing a file on your web server at /.well-known/acme-challenge/
  • DNS-01: Validates domain ownership by adding a TXT record to your DNS (required for wildcard domains)
post/domains

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/domains
  • Auth: HTTP bearer

Request body

challenge_typestring

Challenge type for Let's Encrypt validation. Options: "http-01" (default) or "dns-01"

domainstring required

Response

Domain created successfully

certificatestring nullable

The PEM-encoded certificate chain (can be displayed in browser or downloaded)

created_atinteger required
dns_challenge_tokenstring nullable
dns_challenge_valuestring nullable
domainstring required
expiration_timeinteger nullable
idinteger required
is_wildcardboolean required
last_errorstring nullable
last_error_typestring nullable
last_renewedinteger nullable
on_demand_backoff_untilinteger nullable

On-demand TLS negative-cache deadline (epoch millis), when this hostname's on-demand HTTP-01 issuance is in backoff after a failure (ADR-018 §4). None means no active backoff.

statusstring required
updated_atinteger required
verification_methodstring required

Changes

No recorded changes to this operation across all 53 revisions of this API.