lego/providers/dns/dnshomede/internal/readme.md
2023-01-27 09:28:38 +00:00

37 lines
1.1 KiB
Markdown

# dnshome.de API
## Add TXT record
```
https://<subdomain>:<subdomain_password>@www.dnshome.de/dyndns.php?acme=add&txt=<txtvalue>
```
- `<subdomain>`: the subdomain (ex: `lego.dnshome.de`).
- `<subdomain_password>`: the subdomain password.
- `<txtvalue>`: the value of the TXT record (12 characters minimum)
Only one TXT record can be used for a subdomain.
Always returns StatusOK (200)
If the API call works the first word of the response body is `successfully`.
Can be a POST or a GET, the HTTP method doesn't seem to have an impact.
## Remove TXT record
```
https://<subdomain>:<subdomain_password>@www.dnshome.de/dyndns.php?acme=rm&txt=<txtvalue>
```
- `<subdomain>`: the subdomain (ex: `lego.dnshome.de`).
- `<subdomain_password>`: the subdomain password.
- `<txtvalue>`: the value of the TXT record (12 characters minimum) (IGNORED)
Only one TXT record can be used for a subdomain.
Always returns StatusOK (200)
If the API call works the first word of the response body is `successfully`.
Can be a POST or a GET, the HTTP method doesn't seem to have an impact.