client

package

v1.0.2 Latest Latest Go to latest Published: Apr 28, 2021 License: MIT Imports: 6 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package client contains the methods to query and modify resources in the Hetzner DNS API

View Source

const Endpoint = "https://dns.hetzner.com/api/v1/"

Endpoint is the default endpoint for the Hetzner DNS API

This section is empty.

This section is empty.

type Client struct {
	Record *RecordClient
	Zone   *ZoneClient
	// contains filtered or unexported fields
}

Client provides methods to configure the connection to the Hetzner DNS API

func New() *Client

New instantiates a new Client for the Hetzner DNS API

func (c *Client) WithEndpoint(endpoint string) *Client

WithEndpoint configures a Client to use the specified endpoint

func (c *Client) WithToken(token string) *Client

WithToken configures a Client to use the specified token

type RecordClient struct {
	Client *Client
}

RecordClient provides methods to query and modify records in the Hetzner DNS API

func (c *RecordClient) Create(name string, recordType string, value string, zoneId string) (schema.Record, error)

Create created a new Record in the Hetzner DNS API. Allowed recordTypes are A, AAA, NS, MX, CNAME, RP, TXT, SOA, HINFO, SRV, DANE, TLSA, DS, CAA

func (c *RecordClient) Delete(id string) error

Delete deletes a record in the Hetzner DNS API

func (c *RecordClient) GetAll() ([]schema.Record, error)

GetAll receives all records associated with the user from the Hetzner DNS API

func (c *RecordClient) GetById(id string) (schema.Record, error)

GetById receives the record with the specified id from the Hetzner DNS API

func (c *RecordClient) Update(name string, recordType string, value string, zoneId string, id string) (schema.Record, error)

Update updates a record in the Hetzner DNS API

type ZoneClient struct {
	Client *Client
}

ZoneClient provides methods to query zones in the Hetzner DNS API

func (c *ZoneClient) GetAll() ([]schema.Zone, error)

GetAll receives all zones associated with the user from the Hetzner DNS API

func (c *ZoneClient) GetByName(name string) (schema.Zone, error)

GetByName receives the zone with the specified name from the Hetzner DNS API