POST /bsus/api/v1/batches - Adaptive Applications - BlueCat Gateway - 21.1.1

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

Description

Adds servers to a Server Batch

Parameters

Name Description
body Location: body

Type: application/json

The body of the servers to be added to the Server Batch. The JSON body is as follows:
{
  "name": "string",
  "servers": [
    {
      "bam_id": "string",
      "name": "string",
      "management_ip": "string",
      "service_ip": "string",
      "role_enabled": "string",
      "appliance_type": "string",
      "username": "string",
      "password": "string"
    }
  ]
}
Parameters
  • name—the name of the Server Batch.
  • servers—an array of servers to add to the server batch with the following information:
    • bam_id—the object ID of the Address Manager server to which the server is associated.
    • name—the name of the DNS/DHCP Server.
    • management_ip—the IP address of the DNS/DHCP Server management interface.
    • service_ip—the IP address of the DNS/DHCP Server service interface.
    • role_enabled—the role that has been enabled on the DNS/DHCP Server, such as DNS.
    • appliance_type—the appliance type of the DNS/DHCP Server.
    • username—the username used to authenticate with the DNS/DHCP Server.
    • password—the password used to authenticate with the DNS/DHCP Server.

Responses

Status Description
Successful

Code: 200

Body:
{
  "id": "string"
}

The ID of the Server Batch.
Error

Code: 409

Body: 
{
  "error": "The batch with name <batch_name> is already in use"
}
 {
  "error": "The server <batch_name> already exists in batch <batch_id>"
}

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.