api:dns:acmeupdate
Table of Contents
API : DNS Acme Update
Introduction
This request can be used by the ACME client using the PowerDNS module to set which ACME challenges shall be present in the DNS.
Configuration of ACME client
To configure an ACME client to use this API, configure the ACME client to use a PowerDNS server with these settings:
| ServerId | default |
|---|---|
| Token | Token from a Telecom X user on the customer that has the domain(s), create a persistent token on the user. |
| Ttl | 600 |
| Url | https://api.telecomx.dk/dns/acme |
Request
| URL | https://api.telecomx.dk/dns/acme/api/v1/servers/default/zones/DOMAIN | ||
|---|---|---|---|
| Method | PATCH | ||
| Access level | MANAGER, RESELLER, RESELLER_ADMIN, ADMIN. | ||
| Params | DOMAIN | Domain to lookup zone data for | |
Body example
{ "rrsets": [ { "changetype": "REPLACE", "name": "_acme_challenge.example.org.", "type": "TXT", "ttl": 3600, "records": [ { "content": "value-here", disabled: false }, { ... } ] } ] }
Response
| JSON object | ||
|---|---|---|
| success | boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 422 | name | name is invalid |
| 422 | type | Type is invalid |
| 422 | rData | Data is invalid |
| 404 | not_found | DNS not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/dns/acmeupdate.txt · Last modified: 2024/11/07 14:50 by Per Møller