netlify

package module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: May 13, 2022 License: MIT Imports: 13 Imported by: 1

README

NETLIFY for libdns

Go Reference

This package implements the libdns interfaces for Netlify, allowing you to manage DNS records.

Developped to be used with caddy-dns-netlify

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Provider

type Provider struct {
	// API token is used for authentication. Make sure to use a
	// scoped API **token**, NOT a global API **key**. It will
	// need two permissions: Zone-Zone-Read and Zone-DNS-Edit,
	// unless you are only using `GetRecords()`, in which case
	// the second can be changed to Read.
	PersonnalAccessToken string `json:"api_token,omitempty"`
	Logger               *zap.Logger
	// contains filtered or unexported fields
}

Provider implements the libdns interfaces for Cloudflare. TODO: Support pagination and retries, handle rate limits.

func (*Provider) AppendRecords

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

AppendRecords adds records to the zone. It returns the records that were added.

func (*Provider) DeleteRecords

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

DeleteRecords deletes the records from the zone. If a record does not have an ID, it will be looked up. It returns the records that were deleted.

func (*Provider) GetRecords

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

GetRecords lists all the records in the zone.

func (*Provider) SetRecords

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

SetRecords sets the records in the zone, either by updating existing records or creating new ones. It returns the updated records.

Jump to

Keyboard shortcuts

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