GET /bsus/api/v1/scheduled_update - Adaptive Applications - BlueCat Gateway - 22.1

BlueCat Server Update Services Administration Guide

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

Description

Retrieves a list of all scheduled updates.

Parameters

None.

Responses

Status Description
Successful

Code: 200

Body:
{
  "data": [
    {
      "id": "string",
      "run_time": int(epoch),
      "patches": [
        {
          "patch_name": "string",
          "min_disk": int,
          "expected_version": "string",
          "patch_type": "string",
          "file_name": "string",
          "patch_url": "string",
          "md5_url": "string"
        }
      ],
      "batches": [
        {
          "name": "string",
          "servers": [
            {
              "management_ip": "string"
            }
          ],
          "deployment_progress": int,
          "is_completed": bool
        }
      ],
      "run_postscript": false
    }
  ]
}

Results

An array of scheduled update data items, each of which has the following items.

  • id—the ID of the scheduled event.
  • run_time—the scheduled time for the event.
  • patches—an array of patches scheduled to be applied at the given time, with the following information:
    • patch_name—the name of the patch.
    • min_disk—the minimum required disk space for the patch, in KB.
    • expected_version—the expected version of the DNS/DHCP Server after the update.
    • patch_type—the type of patch, such as bind_hotfix.
    • file_name—the file name of the update, typically a *.tar or *.zip file.
    • patch_url—the relative url or path to the patch file.
    • md5_url—the relateive url or path to the MD5 checksum file for the patch.
  • batches—an array of Server Batches on whcich whose servers should have the patches applied:
    • name—the name of the Server Batch.
    • servers—an array of servers in that server batch. Each server item has the following:
      • management_ip—the IP address of the DNS/DHCP Server management interface.
    • deployment_progress—the percentage progress made in updating all servers in this batch.
    • is_completedtrue if all servers in this batch have been patched, false otherwise.
  • 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.

Error

Code: 400

Invalid parameter.

Code: 401

Unauthorized user.

Code: 404

Document not found.

Code: 500

Internal server error.

Body:
{
    "error": "string"
}

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.