README
¶
Gandi for libdns
This package implements the libdns interfaces for Gandi.
Authenticating
This package only supports API Key authentication. Refer to the Gandi's Public API documentation for more information.
Start by retrieving your API key from the Security section in Gandi account admin panel to be able to make authenticated requests to the API.
Cross-organization access
If the PAT user's default organization is not the one that owns the domain you want to manage, list endpoints (/v5/domain/domains, /v5/livedns/domains) will still find the domain because Gandi filters by all visible orgs, but per-record-set endpoints will return 404. Setting Provider.SharingId to the UUID of the org that owns the domain causes the provider to send X-Gandi-Sharing-Id: <uuid> on every request, and the per-record-set endpoints then succeed.
Note: the documented form of this hint is the sharing_id query string parameter, but in practice that form doesn't reach per-record-set endpoints. The X-Gandi-Sharing-Id header is empirically required there but isn't currently part of the public reference.
Technical limitations
The LiveDNS documentation states that records with the same name and type are merged so that their rrset_values are grouped together.
{
"rrset_type": "MX",
"rrset_ttl": 1800,
"rrset_name": "@",
"rrset_href": "https://api.gandi.net/v5/livedns/domains/gconfs.fr/records/@/MX",
"rrset_values": [
"1 aspmx.l.google.com.",
"5 alt1.aspmx.l.google.com.",
"5 alt2.aspmx.l.google.com.",
"10 alt3.aspmx.l.google.com."
]
}
On the above example, such a design forces us to perform a PUT to add a new @ 1800 IN MX 10 alt4.aspmx.l.google.com. record instead of a simple POST. Thus, we can not use POST to add new records if there is already existing records with the same name and type.
AppendRecords appends values to an existing rrset of the same name and type, while SetRecords replaces the rrset with the value(s) provided (upsert semantics). Due to these technical limitations, updating or appending records may affect the TTL of similar records which have the same name and type.
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 {
BearerToken string `json:"bearer_token,omitempty"`
SharingId string `json:"sharing_id,omitempty"`
// contains filtered or unexported fields
}
Provider implements the libdns interfaces for Gandi.
func (*Provider) AppendRecords ¶
func (p *Provider) AppendRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
AppendRecords adds records to the zone and returns the records that were created. Due to technical limitations of the LiveDNS API, it may affect the TTL of similar records
func (*Provider) DeleteRecords ¶
func (p *Provider) DeleteRecords(ctx context.Context, zone string, records []libdns.Record) ([]libdns.Record, error)
DeleteRecords deletes records from the zone and returns the records that were deleted.
func (*Provider) GetRecords ¶
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, and returns the recordsthat were updated. Due to technical limitations of the LiveDNS API, it may affect the TTL of similar records.
Source Files