/user/api/v1/servicePoints/{id}/serviceInstances (POST) - BlueCat DNS Edge

DNS Edge User Guide (Service Point v4)

Locale
English
Product name
BlueCat DNS Edge

Deploys an instance of a service to a specified Service Point v4.

Request: POST https://us.fleet.bluec.at/user/api/v1/servicePoints/{id}/serviceInstances
Authorization: Bearer token
Content-Type: Application/JSON
{
  "serviceDescriptorID": "bind9-1.0.113",
  "name": "Branch 0802 DNS",
  "parameters": [
    {
      "name": "BamUrl",
      "value": "http://bam.customer.com/api/v1/XFER"
    },
    {
      "name": "BamTimeout",
      "value": 17
    },
    {
      "name": "BindMemoryMB",
      "value": 128
    },
    {
      "name": "ApiKey",
      "value": "ce87b99ead5f11edafa10242ac120002"
    }
  ],
  "ingressEndpoints": [
    {
      "portLabel": "dns",
      "addresses": [
        "10.244.149.91",
        "fda5:574d:2:1::91",
        "192.168.0.99"
      ]
    },
    {
      "portLabel": "management",
      "addresses": [
        "10.244.149.91"
      ]
    },
    {
      "portLabel": "healthcheck",
      "addresses": [
        "10.244.149.100"
      ]
    }
  ]
}

Path parameter

Name Description Type Required/Optional
id The Service Point v4 ID Integer Required
Body parameters
  • serviceDescriptorID—the ID of the service instance that you would like to deploy
  • name—the name that you would like to deploy to the service instance
  • parameters—information about the service including the following fields:
    • name—the name of the service parameter
    • value—the value of the service parameter
  • ingressEndpoints—information about the ingress endpoints of the service including the following fields:
    • portLabel—the label for the ingress endpoint
    • addresses—the service IP addresses of the service point that bind to the ingress endpoint

Successful response

202 Accepted
{
  "id": "9d1fc0e2b19011edafa10242ac120002"
}

Where the id is the unique ID of the service instance.