REST API endpoints - Adaptive Applications - BlueCat Gateway - 24.1

BlueCat Cisco ACI Adaptive Plugin Guide
Locale
English
Product name
BlueCat Gateway
Version
24.1
The BlueCat Cisco API plugin includes REST APIs to retrieve information and configure the Adaptive Application. This workflow uses the following main HTTP methods for interacting with objects:
HTTP Method Description
GET Retrieve data
POST Upload data
DELETE Delete data

Endpoint

When working with the workflow of this API, you can invoke different methods by appending the API endpoint to the BlueCat Gateway URL.
GET http://<Gateway URL>/cisco_aci/api/v1/<API endpoint>

For example, the following GET API call retrieves ACI discovery and BlueCat Address Manager import settings.

GET http://<Gateway URL>/cisco_aci/api/v1/discovery

REST API Swagger documentation

To access the REST API Swagger documentation while within the BlueCat Cisco ACI UI, click Help in the window header and select BlueCat Cisco ACI plugin API. You can also access the Swagger documentation by entering the following URL in your browser:

http://<Gateway URL or IP>/cisco_aci/api/v1/doc

From here, you can view a list of all supported API methods, their input parameters, and test the API methods.

To download the OpenAPI JSON specification, enter the following URL in your browser:

http://<Gateway URL or IP>/cisco_aci/api/v1/swagger.json

List of BlueCat Cisco ACI API endpoints

Endpoint Description
Cisco ACI Discovery
GET /discovery Retrieves ACI discovery and BlueCat Address Manager import settings
POST /discovery Performs one-time or scheduled discoveries on provided ACI infrastructure and imports discovered details into BlueCat Address Manager
POST /discovery/tenants Retrieves information about tenants in a Cisco APIC
Cisco ACI Fabric
POST /import_fabric

Imports the ACI Fabric information into BlueCat Address Manager
Cisco ACI Schedule
GET /schedule

Retrieves the scheduled configuration settings of Cisco ACI
POST /schedule/pause

Pauses the current scheduled discovery process