BlueCat Horizon OpenAPI - User Guide - BlueCat Horizon

BlueCat Horizon User Guide
ft:locale
en-US
Product name
BlueCat Horizon

The BlueCat Horizon OpenAPI provides a unified interface for managing users, groups, roles, audit logs, and connections. It also enables automation of DNS, DHCP, and IPAM services through the DDI orchestrator application.

This workflow uses the following main HTTP methods for interacting with objects:

HTTP method Description
GET Retrieve data
POST Create data
PATCH Modify data
PUT Replace data
DELETE Delete data

Endpoints

When working with the BlueCat Horizon API, you can invoke different methods by appending the API endpoint to the BlueCat Horizon URL.

GET https://<<rdcDomain>.bluecathorizon.com or IP>/api/v1/<API endpoint>

For example, the following GET API call retrieves a list of your connections:

GET https://<<rdcDomain>.bluecathorizon.com or IP>/api/v1/connections

BlueCat Horizon API Swagger documentation

To access the REST API Swagger documentation from within BlueCat Horizon, navigate to Administration > API documentation.

This page provides a list of all supported API methods for the platform, their input parameters, and the ability to test out the methods.

Note: API methods for DDI orchestrator are not included on this page. For DDI orchestrator's API documentation, refer to https://api.menandmice.com/.

The API documentation page in BlueCat Horizon provides an interactive reference for the platform API.