README
¶
Cloudflare for libdns
This package implements the libdns interfaces for Cloudflare.
Authenticating
This package supports API token authentication.
You will need to create a token with the following permissions:
- Zone / Zone / Read
- Zone / DNS / Edit
The first permission is needed to get the zone ID, and the second permission is obviously necessary to edit the DNS records. If you're only using the GetRecords() method, you can change the second permission to Read to guarantee no changes will be made.
To clarify, do NOT use API keys, which are globally-scoped:
DO use scoped API tokens:
Documentation
¶
Index ¶
- type Provider
- func (p *Provider) AppendRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
- func (p *Provider) DeleteRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
- func (p *Provider) GetRecords(ctx context.Context, zone string) ([]libdns.Record, error)
- func (p *Provider) SetRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
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.
APIToken string `json:"api_token,omitempty"`
// 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 ¶
GetRecords lists all the records in the zone.
Source Files