/v1/api/dnsResolverServices (POST) - BlueCat Edge - Service Point v4.x.x

BlueCat Edge User Guide

Locale
English
Product name
BlueCat Edge
Version
Service Point v4.x.x
Initiate deployment of a DNS resolver service on a Service Point v4 instance.
Attention: Once the API has been successfully called, the deployment task is queued and does not indicate that the DNS resolver service has been immediately deployed.
POST https://api-<BlueCat.edge.url>/v1/api/dnsResolverServices
Authorization: Bearer token
Content-Type: Application/JSON
{
    "siteId": "site-123",
    "name": "drs-name",
    "servicePointId": "fleet-sp-123",
    "ipAddresses": [ "1.2.3.4" ],
    "ingressEndpoints": [
    {
      "portLabel": "dns",
      "addresses": [
        "10.244.149.91",
        "fda5:574d:2:1::91",
        "192.168.0.99"
      ]
    },
    {
      "portLabel": "ss-http"
    }
  ]
}
Body parameters
  • siteId—the ID of the site to which you would like to deploy the DNS resolver service
  • name—the name of the DNS resolver service
  • servicePointId—the ID of the service point that you would like to deploy the DNS resolver service to
  • ipAddresses(For DNS resolver service v3.9.x and below) a list of service IP addresses.
    Attention: The ipAddresses field is required if you are deploying DNS resolver service version 3.9.x and below. If you are deploying DNS resolver service version 3.10.0 and above, use the ingressEndpoints field to define the service IP addresses.

    The ingressEndpoints parameters replaces the ipAddresses in future releases.

  • ingressEndpoints(For DNS resolver service v3.10.0 and above) information about the ingress endpoints of the service including the following fields:
    • portLabel—the label for the ingress endpoint. The port label can only be one of the following:
      • dns—the endpoint will be used for DNS service. When the endpoint is dns, the addresses field specifies the IP addresses that the ingress endpoint will listen on for DNS service.
      • ss-http—the endpoint will be used for health and diagnostics. When the endpoint is ss-http, the addresses field specifies the IP addresses that the ingress endpoint will listen on for health and diagnostics.
      Note: If you do not specify an IP address, the defined port label binds to all primary IP addresses of the service point.
    • addresses—the service IP addresses of the service point that bind to the ingress endpoint
Attention: The ingressEndpoints parameter is only available on DNS Resolver Service v3.10.0 and greater.

Successful response

202 ACCEPTED

A response header Location is included of the format /v1/dnsResolverServices/<id>. The <id> is the ID of the DNS resolver service which is to be deployed.

Possible error codes
  • 400 - Can be caused by one of the following:
    • Invalid request body is provided
    • Invalid ingress endpoints
    • The name is already in use by another DRS
    • The fleet instance given in servicePointId already has a DRS deployed
    • The site that this DRS is under is on a version that does not support DNS resolver service on Fleet (version earlier than 3.5.2)
  • 404 The service point does not exist
  • 500 Internal Server Error