Sign in
Domains

Setup DNS challenge records automatically using a DNS provider

This endpoint automatically creates the required DNS TXT records for ACME DNS-01 challenge validation using a configured DNS provider. The domain must have an active DNS challenge pending (created via POST /domains/{id}/order with dns-01 challenge type).

This is similar to how email domain DNS records are auto-provisioned.

post/domains/{domain_id}/setup-dns

Request

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

Path parameters

domain_idinteger required

Domain ID

Request body

dns_provider_idinteger required

The ID of the DNS provider to use for creating the TXT records

Response

DNS records created successfully

messagestring required

Human-readable summary message

records_createdinteger required

Number of TXT records that were successfully created

successboolean required

Overall success status (true if all records were created)

total_recordsinteger required

Total number of TXT records required for the challenge

Example response

{
  "results": [
    {
      "name": "_acme-challenge.example.com",
      "value": "abc123..."
    }
  ]
}

Changes

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