internal

Documentation

Index

• type APIRequest
• type APIResponse
  • func (a APIResponse[D]) GetCode() int
  • func (a APIResponse[D]) GetResult() string
• type Client
  • func NewClient(username string, password string) *Client
  • func (c *Client) AddRecord(ctx context.Context, zone string, record DNSRow) error
  • func (c *Client) Commit(ctx context.Context, zone string) error
  • func (c *Client) DeleteRecord(ctx context.Context, zone string, recordID string) error
  • func (c *Client) GetRecords(ctx context.Context, zone string) ([]DNSRow, error)
  • func (c *Client) Ping(ctx context.Context) error
• type DNSRow
• type DNSRowRequest
• type Response
• type ResponsePayload
• type Rows

Types

type APIRequest

type APIRequest struct {
	User    string `json:"user,omitempty"`
	Auth    string `json:"auth,omitempty"`
	Command string `json:"command,omitempty"`
	Data    any    `json:"data,omitempty"`
}

type APIResponse

type APIResponse[D any] struct {
	Response ResponsePayload[D] `json:"response"`
}

func (APIResponse[D]) GetCode

func (a APIResponse[D]) GetCode() int

func (APIResponse[D]) GetResult

func (a APIResponse[D]) GetResult() string

type Client

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

Client the API client for Webos.

func NewClient

func NewClient(username string, password string) *Client

NewClient creates a new Client.

func (*Client) AddRecord

func (c *Client) AddRecord(ctx context.Context, zone string, record DNSRow) error

AddRecord adds a record in the zone, either by updating existing records or creating new ones. https://kb.wedos.com/en/wapi-api-interface/wapi-command-dns-add-row/ https://kb.wedos.com/en/wapi-api-interface/wapi-command-dns-row-update/

func (*Client) Commit

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

Commit not really required, all changes will be auto-committed after 5 minutes. https://kb.wedos.com/en/wapi-api-interface/wapi-command-dns-domain-commit/

func (*Client) DeleteRecord

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

DeleteRecord deletes a record from the zone. If a record does not have an ID, it will be looked up. https://kb.wedos.com/en/wapi-api-interface/wapi-command-dns-row-delete/

func (*Client) GetRecords

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

GetRecords lists all the records in the zone. https://kb.wedos.com/en/wapi-api-interface/wapi-command-dns-rows-list/

func (*Client) Ping

func (c *Client) Ping(ctx context.Context) error

type DNSRow

type DNSRow struct {
	ID   string      `json:"ID,omitempty"`
	Name string      `json:"name,omitempty"`
	TTL  json.Number `json:"ttl,omitempty"`
	Type string      `json:"rdtype,omitempty"`
	Data string      `json:"rdata"`
}

type DNSRowRequest

type DNSRowRequest struct {
	ID     string      `json:"row_id,omitempty"`
	Domain string      `json:"domain,omitempty"`
	Name   string      `json:"name,omitempty"`
	TTL    json.Number `json:"ttl,omitempty"`
	Type   string      `json:"type,omitempty"`
	Data   string      `json:"rdata"`
}

type Response

type Response interface {
	GetCode() int
	GetResult() string
}

type ResponsePayload

type ResponsePayload[D any] struct {
	Code      int    `json:"code,omitempty"`
	Result    string `json:"result,omitempty"`
	Timestamp int    `json:"timestamp,omitempty"`
	SvTRID    string `json:"svTRID,omitempty"`
	Command   string `json:"command,omitempty"`
	Data      D      `json:"data"`
}

type Rows

type Rows struct {
	Rows []DNSRow `json:"row"`
}