Spaceship for libdns

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

Configuration

To use this provider, you need a Spaceship API key and secret. Configure the provider as follows:

provider := &libdnsspaceship.Provider{
    APIKey:    "your-spaceship-api-key",
    APISecret: "your-spaceship-api-secret",
}

Optionally, you can customize the API base URL (defaults to https://spaceship.dev/api):

provider := &libdnsspaceship.Provider{
    APIKey:    "your-spaceship-api-key",
    APISecret: "your-spaceship-api-secret",
    BaseURL:   "https://custom-api.spaceship.com",
}

Environment Variables

Alternatively, you can use environment variables or the NewProviderFromEnv() constructor to configure the provider:

provider := libdnsspaceship.NewProviderFromEnv()

The following environment variables are supported:

Environment Variable	Description	Required	Default
LIBDNS_SPACESHIP_APIKEY	Your Spaceship API key	Yes	-
LIBDNS_SPACESHIP_APISECRET	Your Spaceship API secret	Yes	-
LIBDNS_SPACESHIP_BASEURL	Custom API base URL	No	https://spaceship.dev/api
LIBDNS_SPACESHIP_PAGESIZE	Page size for GetRecords pagination	No	100
LIBDNS_SPACESHIP_TIMEOUT	HTTP client timeout in seconds	No	30

Example .env file

LIBDNS_SPACESHIP_APIKEY=your_api_key_here
LIBDNS_SPACESHIP_APISECRET=your_api_secret_here
LIBDNS_SPACESHIP_BASEURL=https://spaceship.dev/api
LIBDNS_SPACESHIP_PAGESIZE=100
LIBDNS_SPACESHIP_TIMEOUT=30

Usage

package main

import (
    "context"
    "time"
    
    "github.com/Redth/libdns-spaceship"
    "github.com/libdns/libdns"
)

func main() {
    provider := &libdnsspaceship.Provider{
        APIKey:    "your-spaceship-api-key",
        APISecret: "your-spaceship-api-secret",
    }
    
    zone := "example.com."
    
    // Get all records
    records, err := provider.GetRecords(context.TODO(), zone)
    if err != nil {
        panic(err)
    }
    
    // Add a new A record
    newRecords := []libdns.Record{
        libdns.Address{
            Name: "test",
            TTL:  300 * time.Second,
            IP:   netip.MustParseAddr("192.0.2.1"),
        },
    }
    
    createdRecords, err := provider.AppendRecords(context.TODO(), zone, newRecords)
    if err != nil {
        panic(err)
    }
}

Supported Record Types

This provider supports the following DNS record types:

• A and AAAA records (libdns.Address)
• TXT records (libdns.TXT)
• CNAME records (libdns.CNAME)
• MX records (libdns.MX)
• SRV records (libdns.SRV)
• NS records (libdns.NS)
• CAA records (libdns.CAA)
• HTTPS records (libdns.ServiceBinding with scheme "https")

Unsupported record types (such as PTR, TLSA, etc.) are filtered out and not returned by GetRecords.

API Documentation

For more information about the Spaceship API, see the official documentation.

License

MIT License (See LICENSE file)