Service Point API client - Platform - BlueCat Gateway - 21.11.2

Gateway Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
21.11.2

Module for the client to work with BlueCat Service Point API.

class bluecat_libraries.service_point.api.client.ServicePointClient(url)

Bases: bluecat_libraries.http_client.client.Client

Client uses the requests library to communicate with Service Point.

get_v1_status_health()

The health probe API validates the status of DNS resolution. Use this method to configure the DNS Edge

  • service point behind load balancers.

Example:

from bluecat_libraries.service_point.api import ServicePointClient

client = ServicePointClient(<service_point_url>)
try:
    client.get_v1_status_health()
catch Exception:
    available = False
else:
    available = True

New in version 20.6.1.

get_v1_status_spdiagnostics()

Use this method for troubleshoot a service point. It returns the overall health status of the service point, the service point ID, each service’s status and service version, configured forwarder IPs, the current local time and time zone, and policy details.

Example:

from bluecat_libraries.service_point.api import ServicePointClient

client = ServicePointClient(<service_point_url>)
status_spdiagnostics = client.get_v1_status_spdiagnostics()

New in version 20.6.1.