Skip to content

Commit

Permalink
docs: update dnshomede API documentation (#1871)
Browse files Browse the repository at this point in the history
Co-authored-by: Bodenhaltung <[email protected]>
  • Loading branch information
Bodenhaltung and Bodenhaltung authored Mar 18, 2023
1 parent 64afeca commit 86d9e56
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions providers/dns/dnshomede/internal/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,25 @@ 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.
If an error encoured the response body is `error - <ERRMSG>`.

Can be a POST or a GET.

## 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_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.
If an error encoured the response body is `error - <ERRMSG>`.

Can be a POST or a GET.

0 comments on commit 86d9e56

Please sign in to comment.