POST /bsus/api/v1/deployment/apply - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

Locale
English (United States)
Product name
BlueCat Gateway
Version
22.1

Description

Applies patches to a Server Batch.

Parameters

Name Description
body Location: body

Type: application/json

The body of the patches to be applied to the specified Server Batch. The JSON body is as follows:
{
  "batches": [
    {
      "id": "string",
      "name": "string",
      "servers": [
        {
          "management_ip": "string"
        }
      ]
    }
  ],
  "patches": [
    {
      "id": "string"
    }
  ],
  "datetime": 0,
  "run_postscript": true
}
Parameters
  • id—the ID of the Server Batch.
  • name—the name of the Server Batch.
  • servers—an array of IP addresses of the servers with the following information:
    • management_ip—the IP address of the server's management interface.
  • patches—an array of patches to apply to the Server Batch with the following information:
    • id—the ID of the patch to apply.
  • datetime—the time at which the patch is to be applied.
  • run_postscript—if true, the Server Batch's associated customization package is applied during that scheduled update event. Before the update, the package is called with the backup option (-b). After the update, the package is called with the restore option (-r).

    If false, the customization is not applied during that scheduled event.

Responses

Status Description
Successful

Code: 200

Body:
{
  "status": "Send apply message success"
} 
Error

Code: 401

Unauthorized user.

Code: 500

Internal server error.

{
  "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.