alexvanin/lego
1
0
Fork 0
forked from TrueCloudLab/lego
Code Pull requests Activity

docs: update dnshomede API documentation (#1871)

Browse source 
Co-authored-by: Bodenhaltung <norbert+git@bodenhaltung.com>
This commit is contained in:
Bodenhaltung 2023-03-18 21:11:54 +01:00 committed by GitHub
parent 64afecac21
commit 86d9e5632c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
providers/dns/dnshomede/internal/readme.md
View file

@ -16,17 +16,18 @@ Always returns StatusOK (200)
If the API call works the first word of the response body is `successfully`. 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. If an error encoured the response body is `error - <ERRMSG>`.
Can be a POST or a GET.
## Remove TXT record ## Remove TXT record
``` ```
https://<subdomain>:<subdomain_password>@www.dnshome.de/dyndns.php?acme=rm&txt=<txtvalue> https://<subdomain>:<subdomain_password>@www.dnshome.de/dyndns.php?acme=rm
``` ```
- `<subdomain>`: the subdomain (ex: `lego.dnshome.de`). - `<subdomain>`: the subdomain (ex: `lego.dnshome.de`).
- `<subdomain_password>`: the subdomain password. - `<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. Only one TXT record can be used for a subdomain.
@ -34,4 +35,6 @@ Always returns StatusOK (200)
If the API call works the first word of the response body is `successfully`. 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. If an error encoured the response body is `error - <ERRMSG>`.
Can be a POST or a GET.