REST API endpoints - BlueCat Integrity - 26.1.0

Address Manager Administration Guide
ft:locale
en-US
Product name
BlueCat Integrity
Version
26.1.0
Cloud Discovery & Visibility includes REST APIs to retrieve information and configure the Adaptive Application. This workflow uses three main HTTP methods for interacting with different objects:
HTTP Method Description
GET Retrieve data
POST Upload data
PUT Update 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 Address Manager URL. For example, the following GET API call retrieves a list of all configured discovery jobs in AWS, Azure, or GCP.
GET http://<BAM_url_or_ip>/fm/1/api/v1/provider/<aws_azure_or_gcp>/discovery

Where <aws_azure_or_gcp> is either aws, azure, or gcp.

Authentication

The Cloud Discovery & Visibility API endpoints require an authorization token to be passed in the header to successfully execute. For more information on the API that retrieves an authorization token, refer to the REST API Swagger documentation.

REST API Swagger documentation

To access the REST API Swagger documentation, click the help icon at the top right of the Address Manager UI and select Cloud Discovery & Visibility API documentation. You can also access this documentation by entering the following URL in your browser:

http://<BAM_url_or_ip>/fm/1/api/v1/doc/

From here, you can view a list of all supported API methods, their input parameters, and test the API methods. You can also download the OpenAPI JSON specification using the following URL in your browser:

http://<BAM_url_or_ip>/cloud-discovery/api/v1/swagger.json

Tip: Use the Select a provider drop-down menu at the top right of the Swagger UI to switch between general and cloud-platform specific endpoints.