REST API endpoints - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.1
BlueCat Server Update Services includes REST APIs to retrieve information and configure the Adaptive Application. This workflow uses four 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 server batches:
GET http://<Gateway_url>/bsus/api/v1/batches

Authentication

The BlueCat Server Update Services 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 BlueCat Server Update Services UI, you can access the latest REST API Swagger documentation by entering the following URL in your browser: http://<Gateway_hostname_or_IP>/bsus/api/v1/doc

From this page, 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>/bsus/api/v1/swagger.json