/user/api/v1/serviceCatalog/{id} (GET) - BlueCat DNS Edge

DNS Edge User Guide (Service Point v4)

Locale
English
Product name
BlueCat DNS Edge

Retrieve information about a service descriptor in the service catalog.

Request: GET https://us.fleet.bluec.at/user/api/v1/serviceCatalog/{id}
Authorization: Bearer token

Path parameter

Name Description Type Required/Optional
id The ID of the service String Optional

Successful response

200 OK
{
  "id": "string",
  "serviceName": "bind9",
  "version": "1.0.113",
  "description": "Authoritative DNS Nameserver",
  "exposedPorts": "EXPOSED",
  "parameters": [
    {
      "name": "BamUrl",
      "description": "Full URL for the BAM API",
      "type": "URL",
      "exampleValue": "http://bam.customer.com/api/v1/XFER"
    },
    {
      "name": "BamTimeout",
      "description": "BAM timeout, in ms. Defaults to 10 ms",
      "type": "INTEGER",
      "exampleValue": 10
    },
    {
      "name": "BindMemoryMB",
      "description": "Bind container maximum memory. Defaults to 80, but increase for higher performance.",
      "type": "INTEGER",
      "exampleValue": 80
    },
    {
      "name": "ApiKey",
      "description": "API key for the bind service.",
      "type": "STRING",
      "exampleValue": "ce87b99ead5f11edafa10242ac120002"
    }
  ],
  "ingressEndpoints": [
    {
      "portLabel": "dns",
      "description": "The authoritative Bind9 DNS server.",
      "protocol": "dns"
    },
    {
      "portLabel": "management",
      "description": "An nginx webserver that serves information about the container's environment.",
      "protocol": "tcp"
    },
    {
      "portLabel": "healthcheck",
      "description": "A simple HTTP liveness check.",
      "protocol": "tcp"
    }
  ]
}
Where the parameters represent the following:
  • id—the unique ID of the service
  • serviceName—the name of the service
  • version—the version of the service
  • description—the description of the service
  • exposedPorts—indicates how the exposed ports are used. The values can be EXPOSED or INTERNAL.
  • parameters—information about the service parameters including the following fields:
    • name—the name of the service parameter
    • description—the description of the service parameter
    • type—the type of the value of the service parameter. The type can be one of the following:
      • INTEGER
      • STRING
      • URL
      • BOOLEAN
    • exampleValue—an example 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
    • description—the description of the ingress endpoint
    • protocol—the protocol used for the ingress endpoint. The protocol can be tcp or dns.