hetzner

README

Hetzner DNS for libdns

This package implements the libdns interfaces for the Hetzner DNS API.

Authenticating

To authenticate, you need to supply a Hetzner Auth-API-Token.

Example

See examples and provider_test.go.

License

MIT

Documentation

Index

• type Client
  • func NewClient(accessToken string) *Client
  • func (c *Client) CreateRecord(ctx context.Context, zone string, r Record) (Record, error)
  • func (c *Client) DeleteRecord(ctx context.Context, id string) error
  • func (c *Client) GetAllRecords(ctx context.Context, zone string) ([]Record, error)
  • func (c *Client) GetZoneID(ctx context.Context, zone string) (string, error)
  • func (c *Client) UpdateRecord(ctx context.Context, zone string, r Record) (Record, error)
• type Provider
  • func New(token string) *Provider
  • func (p *Provider) AppendRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
  • func (p *Provider) DeleteRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
  • func (p *Provider) GetRecords(ctx context.Context, zone string) ([]libdns.Record, error)
  • func (p *Provider) SetRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
• type Record
  • func (r *Record) Parse(zone string) (libdns.Record, error)
  • func (r *Record) RR() libdns.RR
• type Zone

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a Hetzner DNS API client.

func NewClient

func NewClient(accessToken string) *Client

NewClient returns a new Client.

func (*Client) CreateRecord

func (c *Client) CreateRecord(ctx context.Context, zone string, r Record) (Record, error)

CreateRecord creates a record for the given zone.

func (*Client) DeleteRecord

func (c *Client) DeleteRecord(ctx context.Context, id string) error

DeleteRecord deletes a record for the given ID and zone.

func (*Client) GetAllRecords

func (c *Client) GetAllRecords(ctx context.Context, zone string) ([]Record, error)

GetAllRecords returns all records for the given zone.

func (*Client) GetZoneID

func (c *Client) GetZoneID(ctx context.Context, zone string) (string, error)

GetZoneID returns the zone ID for the given zone name.

func (*Client) UpdateRecord

func (c *Client) UpdateRecord(ctx context.Context, zone string, r Record) (Record, error)

UpdateRecord updates a record for the given zone.

type Provider

type Provider struct {
	// AuthAPIToken is the Hetzner Auth API token - see https://dns.hetzner.com/api-docs#section/Authentication/Auth-API-Token
	AuthAPIToken string `json:"auth_api_token"`
	// contains filtered or unexported fields
}

Provider implements the libdns interfaces for Hetzner.

func New

func New(token string) *Provider

New returns a new libdns provider for Hetzner.

func (*Provider) AppendRecords

func (p *Provider) AppendRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)

AppendRecords implements the libdns.RecordAppender interface.

func (*Provider) DeleteRecords

func (p *Provider) DeleteRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)

DeleteRecords implements the libdns.RecordDeleter interface.

func (*Provider) GetRecords

func (p *Provider) GetRecords(ctx context.Context, zone string) ([]libdns.Record, error)

GetRecords implements the libdns.RecordGetter interface.

func (*Provider) SetRecords

func (p *Provider) SetRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)

SetRecords implements the libdns.RecordSetter interface.

type Record

type Record struct {
	ID     string `json:"id,omitempty"`
	ZoneID string `json:"zone_id,omitempty"`
	Type   string `json:"type"`
	Name   string `json:"name"`
	Value  string `json:"value"`
	TTL    int    `json:"ttl"`
}

Record is the record type for Hetzner implementing the libdns.Record interface.

func (*Record) Parse

func (r *Record) Parse(zone string) (libdns.Record, error)

Parse parses a record from the Hetzner API response into libdns.Record.

func (*Record) RR

func (r *Record) RR() libdns.RR

RR implements the libdns.Record interface.

type Zone

type Zone struct {
	ID string `json:"id"`
}

Zone is the zone type for Hetzner.