porkbun

README

Porkbun for libdns

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

Usage

Porkbun API documentation details the process of getting an API key & enable API access for the domain.

An example of usage can be seen in _test/test.go. To run clone the .env_template to a file named .env and populate with the API key and secret API key.

Documentation

Overview

Package porkbun implements a DNS record management client compatible with the libdns interfaces for Porkbun.

Index

• Constants
• func LibdnsNameToPorkbunName(name string, zone string) string
• func LibdnsZoneToPorkbunDomain(zone string) string
• func MakeApiRequest[T any](endpoint string, body io.Reader, responseType T) (T, error)
• type ApiCredentials
• type Provider
  • func (p *Provider) AppendRecords(_ context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
  • func (p *Provider) CheckCredentials(_ context.Context) (string, error)
  • func (p *Provider) DeleteRecords(_ context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
  • func (p *Provider) GetRecords(_ context.Context, zone string) ([]libdns.Record, error)
  • func (p *Provider) ListZones(ctx context.Context) ([]libdns.Zone, error)
  • func (p *Provider) SetRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)

Constants

const ApiBase = "https://api.porkbun.com/api/json/v3"

Functions

func LibdnsNameToPorkbunName

func LibdnsNameToPorkbunName(name string, zone string) string

Converts libdns' name representation to porkbun's

func LibdnsZoneToPorkbunDomain

func LibdnsZoneToPorkbunDomain(zone string) string

LibdnsZoneToPorkbunDomain Strips the trailing dot from a Zone

func MakeApiRequest

func MakeApiRequest[T any](endpoint string, body io.Reader, responseType T) (T, error)

Types

type ApiCredentials

type ApiCredentials struct {
	Apikey       string `json:"apikey"`
	Secretapikey string `json:"secretapikey"`
}

type Provider

type Provider struct {
	APIKey       string `json:"api_key,omitempty"`
	APISecretKey string `json:"api_secret_key,omitempty"`
}

Provider facilitates DNS record manipulation with Porkbun.

func (*Provider) AppendRecords

func (p *Provider) AppendRecords(_ 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) CheckCredentials

func (p *Provider) CheckCredentials(_ context.Context) (string, error)

CheckCredentials allows verifying credentials work in test scripts

func (*Provider) DeleteRecords

func (p *Provider) DeleteRecords(_ 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(_ context.Context, zone string) ([]libdns.Record, error)

GetRecords lists all the records in the zone.

func (*Provider) ListZones

func (p *Provider) ListZones(ctx context.Context) ([]libdns.Zone, error)

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.