Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update dnshomede API documentation #1871

Merged
merged 1 commit into from
Mar 18, 2023
Merged

docs: update dnshomede API documentation #1871

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions providers/dns/dnshomede/internal/readme.md
View file
Open in desktop
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.