go-spaceship-sdk

README

Go Spaceship SDK

Go client for the Spaceship domain & DNS API.

• Spaceship API Documentation
• API Manager (create credentials)

Install

go get github.com/namecheap/go-spaceship-sdk

Usage

import "github.com/namecheap/go-spaceship-sdk/client"

c, err := client.NewClient("https://spaceship.dev/api/v1", apiKey, apiSecret)
if err != nil {
    log.Fatal(err)
}

// List domains
domains, err := c.GetDomainList(ctx)

// Add a DNS record
err = c.CreateDNSRecord(ctx, "example.com", client.DNSRecord{
    Type:    "A",
    Name:    "www",
    Address: "11.12.13.14",
    TTL:     3600,
})

Authentication uses the X-API-Key / X-API-Secret headers; credentials are created in the Spaceship API Manager. The library takes credentials explicitly — it does not read environment variables.

What it covers

• Domains — list, get info, auto-renew, nameservers.
• DNS records — list, find, create, upsert, and delete records in the custom group (records owned by Spaceship products are read-only and left untouched). Per-type validation for A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, NS, PTR, SRV, SVCB, TLSA, and TXT.
• Personal nameservers — list, find, upsert, delete.

See the Go Reference for the full method list and signatures.

Testing

Unit tests run with no credentials and are what CI executes:

make test

The SDK also ships live acceptance tests (TestAcc*) that exercise the real Spaceship API. They are skipped unless credentials are set, and the DNS tests create and delete records on a real domain. Copy .env.example to .env and fill it in — make testacc loads .env automatically:

cp .env.example .env   # then set SPACESHIP_API_KEY, SPACESHIP_API_SECRET, SPACESHIP_TEST_DOMAIN
make testacc

Exporting the same variables in your shell works too. SPACESHIP_TEST_DOMAIN is required only for the DNS tests; without it they skip rather than fail.

⚠️ Acceptance tests mutate real DNS records on SPACESHIP_TEST_DOMAIN. Point them at a throwaway domain you control, never a production domain.

See CONTRIBUTING.md for the full test strategy.

Contributing

See CONTRIBUTING.md for the development workflow, test layers, commit conventions, and DCO sign-off.

Security

See SECURITY.md for how to report a vulnerability.

License

Apache 2.0 — see LICENSE.