> For the complete documentation index, see [llms.txt](https://docs.dnscontrol.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dnscontrol.org/provider/spaceship.md).

# Spaceship

### Configuration

To use this provider, add an entry to `creds.json` with `TYPE` set to `SPACESHIP` along with an API key and secret created in [Spaceship API Manager](https://www.spaceship.com/application/api-manager/).

Grant the key `dnsrecords:read`, `dnsrecords:write`, `domains:read`, and `domains:write` scopes.

Example:

{% code title="creds.json" %}

```json
{
  "spaceship": {
    "TYPE": "SPACESHIP",
    "api_key": "your-spaceship-api-key",
    "api_secret": "your-spaceship-api-secret"
  }
}
```

{% endcode %}

The [creds.json](/commands/creds-json.md#example-commands) page in the docs explains how you can generate this dynamically so you can pull the secret token from 1Password or the vault of your choosing.

### Metadata

This provider does not recognize any special metadata fields unique to Spaceship.

### Usage

#### As DNS Provider only

{% code title="dnsconfig.js" %}

```javascript
var REG_NONE = NewRegistrar("none");
var DSP_SPACESHIP = NewDnsProvider("spaceship");

D("example.com", REG_NONE, DnsProvider(DSP_SPACESHIP),
    A("test", "1.2.3.4"),
);
```

{% endcode %}

#### As both Registrar and DNS Provider

{% code title="dnsconfig.js" %}

```javascript
var REG_SPACESHIP = NewRegistrar("spaceship");
var DSP_SPACESHIP = NewDnsProvider("spaceship");

D("example.com", REG_SPACESHIP, DnsProvider(DSP_SPACESHIP),
    A("test", "1.2.3.4"),
);
```

{% endcode %}

#### As Registrar only (DNS hosted elsewhere)

{% code title="dnsconfig.js" %}

```javascript
var REG_SPACESHIP = NewRegistrar("spaceship");
var DSP_OTHER = NewDnsProvider("cloudflare");

D("example.com", REG_SPACESHIP, DnsProvider(DSP_OTHER),
    A("test", "1.2.3.4"),
);
```

{% endcode %}

When used as a registrar, Spaceship updates nameserver delegation. If the desired nameservers are Spaceship's hosted set (`launch1.spaceship.net` and `launch2.spaceship.net`), the provider sends `provider: "basic"`. Any other list is sent as `provider: "custom"`.

### Activation

1. Log in to [Spaceship](https://www.spaceship.com/)
2. Open [API Manager](https://www.spaceship.com/application/api-manager/) and create a key
3. Enable the DNS and domain scopes listed above
4. Put the key and secret in `creds.json`

The domain must already exist in the Spaceship account. This provider cannot create zones.

### Rate limiting

Spaceship returns HTTP 429 with a `Retry-After` header when an endpoint's quota is exceeded. Some quotas are tight: domain info is 5 requests per domain per 300 seconds; DNS record reads and writes are 300 per 300 seconds. The provider waits and retries, honoring `Retry-After`, for up to 10 minutes per request.

A large `push` or an integration-test run can therefore pause for minutes. Increase the Go test timeout when running the suite:

```shell
cd integrationTest
go test -timeout 0 -v -args -verbose -profile SPACESHIP
```

### Record types

Writable custom DNS types: A, AAAA, ALIAS, CAA, CNAME, HTTPS, MX, NS (non-apex), PTR, SRV, SVCB, TLSA, TXT.

TTL values are clamped to 60–3600 seconds (Spaceship's API range). A TTL of 0 becomes 3600.

Apex CNAME is allowed. Apex ALIAS is rejected because Spaceship stores it as a CNAME; declare an apex CNAME instead.

Null MX ([RFC 7505](https://www.rfc-editor.org/rfc/rfc7505.html), `MX("@", 0, ".")`) and SRV records whose target is `.` are not supported. The API requires a hostname for those fields and returns HTTP 422 otherwise.

### Feature Summary

* Provider Type
  * [Official Support](/provider/index.md#providers-with-official-support): ❌
  * DNS Provider: ✅
  * Registrar: ✅
* Provider API
  * [Concurrency Verified](/advanced-features/concurrency-verified.md): ✅
  * [dual host](/advanced-features/dual-host.md): ❌
  * create-domains: ❌
  * [get-zones](/commands/get-zones.md): ✅
* DNS extensions
  * [`ALIAS`](/language-reference/domain-modifiers/alias.md): ✅
  * [`DNAME`](/language-reference/domain-modifiers/dname.md): ❔
  * [`LOC`](/language-reference/domain-modifiers/loc.md): ❌
  * [`PTR`](/language-reference/domain-modifiers/ptr.md): ✅
  * [`SOA`](/language-reference/domain-modifiers/soa.md): ❌
* Service discovery
  * [`DHCID`](/language-reference/domain-modifiers/dhcid.md): ❔
  * [`NAPTR`](/language-reference/domain-modifiers/naptr.md): ❌
  * [`SRV`](/language-reference/domain-modifiers/srv.md): ✅
  * [`SVCB`](/language-reference/domain-modifiers/svcb.md): ✅
* Security
  * [`CAA`](/language-reference/domain-modifiers/caa.md): ✅
  * [`HTTPS`](/language-reference/domain-modifiers/https.md): ✅
  * [`SMIMEA`](/language-reference/domain-modifiers/smimea.md): ❔
  * [`SSHFP`](/language-reference/domain-modifiers/sshfp.md): ❌
  * [`TLSA`](/language-reference/domain-modifiers/tlsa.md): ✅
* DNSSEC
  * [`AUTODNSSEC`](/language-reference/domain-modifiers/autodnssec_on.md): ❌
  * [`DNSKEY`](/language-reference/domain-modifiers/dnskey.md): ❔
  * [`DS`](/language-reference/domain-modifiers/ds.md): ❌