Address Manager supports REST APIs to access Address Manager.
This section describes BlueCat's RESTful API implementation such as the invoking format, how to authenticate and authorize, and REST API samples and limitations.
BlueCat REST APIs support communication over HTTP and HTTPS.
JSON format is supported for sending and receiving data.
REST API format
You can access all BlueCat REST APIs by appending known methods to the base URL http://<AddressManager_IP or hostname>/Services/REST/v1/<api_method_name>.
Web Application Description Language (WADL)
The Address Manager REST API has an accessible WADL. You can access the WADL file by using http://<AddressManager_IP or hostname>/Services/REST/application.wadl.
- API signatures
- HTTP methods (GET/POST/PUT/DELETE) for specific calls
- API request parameters and datatype
- Response datatype and media types
REST API specification file
The Address Manager REST API also includes a 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.