/api/v1/fleetInstances (POST) - BlueCat DNS Edge

DNS Edge User Guide (Fleet Service Point)

Locale
English
Product name
BlueCat DNS Edge

Creates a Fleet Service Point.

Request: POST https://us.fleet.bluec.at/user/api/v1/fleetInstances
Authorization: Bearer token
Content-Type: Application/JSON
{
    "name": "Fleet Service Point Name",
    "description": "Fleet Service Point Description",
    "nodeName": "www.hostname.com",
    "nodeDescription": "Host Description",
    "ipv4CIDRAddress": "1.2.3.4/24",
    "ipv4GatewayAddress": "1.2.3.1",
    "ipv6CIDRAddress": "2001:3:40f::5/64",
    "ipv6GatewayAddress": "2001:3:40f::1",
    "ntpServers": [
        "0.pool.ntp.org",
        "1.pool.ntp.org"
    ],
    "dnsServers": [
        "8.8.8.8",
        "1.1.1.1"
    ],
    "sshPublicKey": "ssh-rsa abcd1234... user@host",
    "consolePassword": "password",
    "httpProxySettings": {
        "host": "proxy.blue.cat",
        "scheme": "http",
        "port": "443",
        "user": "proxy",
        "password": "pass"
    }
}
Body parameters
  • name—the name of the Fleet Service Point
  • description—the description of the Fleet Service Point
  • nodeName—the name of the node
  • nodeDescription—the description of the node
  • ipv4CIDRAddress—the IPv4 CIDR address of the Fleet Service Point
  • ipv4GatewayAddress—the IPv4 gateway address of the Fleet Service Point
  • ipv6CIDRAddress—the IPv6 CIDR address of the Fleet Service Point
  • ipv6GatewayAddress—the IPv6 gateway address of the Fleet Service Point
  • ntpServers—a list of NTP servers used by the Fleet Service Point. If you do not configure any NTP servers, the Fleet Service Point will use the following default Debian NTP servers:
    • 0.debian.pool.ntp.org
    • 1.debian.pool.ntp.org
    • 2.debian.pool.ntp.org
    • 3.debian.pool.ntp.org
  • dnsServers—a list of DNS resolvers used by the Fleet Service Point. If you do not configure any DNS servers, the Fleet Service Point will use 8.8.8.8 as the default DNS server.
  • sshPublicKey—the SSH public key used to access the Fleet Service Point. This adds the public key to the .ssh directory of the Fleet Service Point and allows you to SSH into the Fleet Service Point.
  • consolePassword—the console password for the Fleet Service Point. The password must meet the following requirements:
    • It must contain lowercase characters.
    • It must contain uppercase characters.
    • It must contain numbers.
    • It must contain symbols.
    • It must not contain spaces.
    • It must contain at least 12 characters.
    Note: The sshPublicKey and consolePassword are applied to the operations user account.
    Attention: The sshPublicKey and consolePassword fields are mandatory and must be filled out to provision the Fleet Service Point.
  • httpProxySettings—the HTTP proxy settings for the Fleet Service Point. The HTTP proxy settings include the following information:
    • host—the HTTP proxy hostname
    • scheme—the HTTP proxy URL scheme. The default value is HTTP
    • port—the HTTP proxy port
    • user—the HTTP proxy username used for authentication
    • password—the HTTP proxy password used for authentication

Successful response

202 Accepted
{
  "fleetInstanceID": "string",
  "nodeID": "string",
  "nodeConfig": {
    "vmwareGuestInfo": {
      "userdata": "string",
      "metadata": "string"
    },
    "cloudBase64": "string"
  }
}
Attention: The node configuration information can only be retrieved once and cannot be recovered later. The configuration information contains content that is compressed and base64 encoded, and can contain sensitive information such as HTTP proxy credentials.

BlueCat strongly recommends storing the configuration information in a secure location and only storing the configuration information for as long as required. The configuration information should be securely destroyed when it is no longer in use.