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

BlueCat Server Update Services Administration Guide

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

Description

Schedules a Server Batch to be applied at a specified date and time.

Parameters

Name Description
payload

(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 within the Server Batch.
  • patches—an array of patches to apply to the Server Batch with the following information:
    • id—the ID of the patch to be applied.
  • datetime—the time at which the patch is applied.
    Note: The date and time must be greater than the time at which the API request is sent by at least 5 minutes.
  • run_postscript—if true (the default), 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": "Schedule for apply patches successfully"
}
Error

Code: 400

Bad update request. This can occur if the date and time format is invalid, or if the scheduled timestamp is in the past.

{
  "error": "Invalid date and time. This must be greater than the time to send the request"
}
{
  "error": "The date time format is invalid"
}

Code: 401

Unauthorized user.

Code: 500

Internal server error.