REST API endpoints - Adaptive Applications - BlueCat Gateway - 23.3.2

Cloud Discovery & Visibility Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.3.2
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 Gateway URL. For example, the following GET API call retrieves a list of all configured discovery jobs in AWS, Azure, or GCP.
GET http://<Gateway_url>/cloud-discovery/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

While working within the Cloud Discovery & Visibility UI, you can access the REST API Swagger documentation by clicking in the top right of the Cloud Discovery & Visibility UI and selecting Go to API document. You can also access the REST API Swagger documentation by entering the following URL in your browser:

http://<Gateway_url_or_ip>/cloud-discovery/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://<Gateway_hostname_or_IP>/cloud-discovery/api/v1/swagger.json

Note: In Cloud Discovery & Visibility v21.3 and greater, you can filter Swagger documentation to display relevant information based on the cloud type.