Address Manager Legacy v1 API - REST - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Locale
English
Product name
BlueCat Integrity
Version
9.5.0
This section describes BlueCat's v1 REST API implementation such as the invoking format, how to authenticate and authorize, and v1 REST API samples and limitations.
Attention: All REST API information in this guide is related to the Address Manager v1 REST API. Address Manager v9.5.0 includes a new RESTful v2 API that currently covers most v1 REST API functionality, and is intended to replace the v1 REST API in the future. Information on the Address Manager RESTful v2 API is covered separately in the RESTful v2 API Guide.
  • BlueCat v1 REST APIs support communication over HTTP and HTTPS.

  • JSON format is supported for sending and receiving data.

v1 REST API format

You can access all BlueCat v1 REST APIs by appending known methods to the base URL http://<AddressManager_IP or hostname>/Services/REST/v1/<api_method_name>.

For example, to invoke the getSystemInfo method, you need to enter:
http://{Address_Manager_IP}/Services/REST/v1/getSystemInfo

Web Application Description Language (WADL)

The Address Manager v1 REST API has an accessible WADL. You can access the WADL file by using http://<AddressManager_IP or hostname>/Services/REST/application.wadl.

You can use the WADL file to check various parameters of the API such as:
  • API signatures
  • HTTP methods (GET/POST/PUT/DELETE) for specific calls
  • API request parameters and datatype
  • Response datatype and media types

v1 REST API specification file

The Address Manager v1 REST API also includes a v1 REST API specification file in JSON format. You can access the API specification file in the browser at http://<AddressManager_IP or hostname>/apidocs/api-spec.json. If HTTPS is enabled on Address Manager, use the HTTPS protocol in the address.