GET /bsus/api/v1/batches/{batch_id} - Adaptive Applications - BlueCat Gateway - 21.1.1

BlueCat Server Update Services Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
21.1.1

Description

Retrieves information about a specific Server Batch based on the ID provided.

Parameters

Name Description
batch_id Location: query

Type: string

The ID of the Server Batch that you would like to retrieve information from.

Responses

Status Description
Successful

Code: 200

Body:
[
  {
    "id": "string",
    "name": "string",
    "timestamp": "date string(%Y-%m-%dT%H:%M:%SZ)",
    "servers": [
      {
        "name": "string",
        "order": int,
        "management_ip": "string",
        "service_ip": "string",
        "appliance_type": "string",
        "role_enable": "string",
        "software_version": "string",
        "patches_installed": "string",
        "services_health": int,
        "configuration": "string",
        "bam_id": "string"
      }
    ]
  }
]
Error

Code: 500

Body: 
{
  "error": <>
}

This can be caused when an unknown application error is encountered on the Server side. The API attempts to return additional details within the error parameter.