Skip to content

spaceship.md

Latest commit

 

History

History
36 lines (27 loc) · 1.37 KB

spaceship.md

File metadata and controls

36 lines (27 loc) · 1.37 KB
Raw

Spaceship

Configuration

Example

{
  "settings": [
    {
      "provider": "spaceship",
      "domain": "sub.example.com",
      "api_key": "YOUR_API_KEY",
      "api_secret": "YOUR_API_SECRET",
      "ip_version": "ipv4",
      "ipv6_suffix": ""
    }
  ]
}

Compulsory parameters

  • "domain" is the domain to update. It can be example.com (root domain) or sub.example.com (subdomain of example.com).
  • "api_key" is your API key which can be obtained from the API Manager.
  • "api_secret" is your API secret which is provided along with your API key in the API Manager.

Optional parameters

  • "ip_version" can be ipv4 (A records), or ipv6 (AAAA records) or ipv4 or ipv6 (update one of the two, depending on the public ip found). It defaults to ipv4 or ipv6.
  • "ipv6_suffix" is the IPv6 interface identifier suffix to use. It can be for example 0:0:0:0:72ad:8fbb:a54e:bedd/64. If left empty, it defaults to no suffix and the raw temporary IPv6 address of the machine is used in the record updating. You might want to set this to use your permanent IPv6 address instead of your temporary IPv6 address.
  • "ttl" is the record TTL in seconds, between 60 and 3600. Defaults to the zone default when unset.

Domain setup

More information at the spaceship API.