internal

Documentation

Index

• type APIError
  • func (a APIError) Error() string
• type Client
  • func NewClient(opts ClientOpts, httpClient *http.Client) *Client
  • func (c *Client) AddRecord(zone string, record Record) error
  • func (c *Client) DeleteRecord(zone string, record Record) error
  • func (c *Client) SetRecord(zone string, record Record) error
• type ClientOpts
• type Record
• type RecordChangeAdd
• type RecordChangeDelete
• type RecordChangeSet
• type UpdateDNSZoneRecordsRequest

Types

type APIError

type APIError struct {
	Message string `json:"message"`
}

APIError represents an error response from the API.

func (APIError) Error

func (a APIError) Error() string

type Client

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

Client represents DNS client.

func NewClient

func NewClient(opts ClientOpts, httpClient *http.Client) *Client

NewClient returns a client instance.

func (*Client) AddRecord

func (c *Client) AddRecord(zone string, record Record) error

AddRecord adds Record for given zone.

func (*Client) DeleteRecord

func (c *Client) DeleteRecord(zone string, record Record) error

DeleteRecord deletes a Record for given zone.

func (*Client) SetRecord

func (c *Client) SetRecord(zone string, record Record) error

SetRecord sets a unique Record for given zone.

type ClientOpts

type ClientOpts struct {
	BaseURL string
	Token   string
}

ClientOpts represents options to init client.

type Record

type Record struct {
	Data     string `json:"data,omitempty"`
	Name     string `json:"name,omitempty"`
	Priority uint32 `json:"priority,omitempty"`
	TTL      uint32 `json:"ttl,omitempty"`
	Type     string `json:"type,omitempty"`
	Comment  string `json:"comment,omitempty"`
}

Record represents a DNS record.

type RecordChangeAdd

type RecordChangeAdd struct {
	Records []*Record `json:"records,omitempty"`
}

RecordChangeAdd represents a list of add operations.

type RecordChangeDelete

type RecordChangeDelete struct {
	Data string `json:"data,omitempty"`
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

RecordChangeDelete represents a list of delete operations.

type RecordChangeSet

type RecordChangeSet struct {
	Data    string    `json:"data,omitempty"`
	Name    string    `json:"name,omitempty"`
	TTL     uint32    `json:"ttl,omitempty"`
	Type    string    `json:"type,omitempty"`
	Records []*Record `json:"records,omitempty"`
}

RecordChangeSet represents a list of set operations.

type UpdateDNSZoneRecordsRequest

type UpdateDNSZoneRecordsRequest struct {
	DNSZone          string        `json:"dns_zone,omitempty"`
	Changes          []interface{} `json:"changes,omitempty"`
	ReturnAllRecords bool          `json:"return_all_records,omitempty"`
}

UpdateDNSZoneRecordsRequest represents a request to update DNS records on the API.