ns1

package module

v0.0.0-...-7225d1e Latest Latest Go to latest Published: Mar 14, 2024 License: MIT Imports: 8 Imported by: 1

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

Repository

github.com/CloudPassenger/libdns-ns1

Links

Open Source Insights

README ¶

DEVELOPER INSTRUCTIONS:

This repo is a template for developers to use when creating new libdns provider implementations.

Be sure to update:

The package name
The Go module name in go.mod
The latest libdns/libdns version in go.mod
All comments and documentation, including README below and godocs
License (must be compatible with Apache/MIT)
All "TODO:"s is in the code
All methods that currently do nothing

Remove this section from the readme before publishing.

<PROVIDER NAME> for `libdns`

This package implements the libdns interfaces for <PROVIDER>, allowing you to manage DNS records.

TODO: Show how to configure and use. Explain any caveats.

Documentation ¶

Index ¶

func ToChallengeDomain(zone string, subname string) string
func ToFqdn(name string) string
func UnChallengeDomain(zone string, name string) string
func UnFqdn(name string) string
type Client
type Provider

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ToChallengeDomain ¶

func ToChallengeDomain(zone string, subname string) string

func ToFqdn ¶

func ToFqdn(name string) string

ToFqdn converts the name into a fqdn appending a trailing dot.

func UnChallengeDomain ¶

func UnChallengeDomain(zone string, name string) string

func UnFqdn ¶

func UnFqdn(name string) string

UnFqdn converts the fqdn into a name removing the trailing dot.

Types ¶

type Client ¶

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

type Provider ¶

type Provider struct {
	Client
	// struct tags on exported fields), for example:
	APIKey  string        `json:"api_key,omitempty"`
	Timeout time.Duration `json:"timeout,omitempty"`
}

Provider facilitates DNS record manipulation with ns1.

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. 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.

Source Files ¶

View all Source files

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