internal

package
v4.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 31, 2024 License: MIT Imports: 10 Imported by: 0

README

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.

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
  • <subdomain>: the subdomain (ex: lego.dnshome.de).
  • <subdomain_password>: the subdomain password.

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.

If an error encoured the response body is error - <ERRMSG>.

Can be a POST or a GET.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

Client the dnsHome.de client.

func NewClient

func NewClient(credentials map[string]string) *Client

NewClient Creates a new Client.

func (*Client) Add

func (c *Client) Add(ctx context.Context, hostname, value string) error

Add adds a TXT record. only one TXT record for ACME is allowed, so it will update the "current" TXT record.

func (*Client) Remove

func (c *Client) Remove(ctx context.Context, hostname, value string) error

Remove removes a TXT record. only one TXT record for ACME is allowed, so it will remove "all" the TXT records.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL