Patch APIs

This topic describes the REST APIs for patches in BMC Helix Automation Console.

The base URL for the Patch API is: https://<serverName>/api/v1

PUT/api/v1/catalogs/patch

Retrieves all the patches based on the patch IDs that are part of the input payload.

Request body: No parameters

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

PUT/api/v1/catalogs/{catalogId}/patch/search

Updates all patches from Automation Console based on the filter properties.

Request body

Parameter	Description
catalogId	Specifies a catalog ID

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Sample request

{
  "filter": "string",
  "from": 0,
  "properties": "string",
  "size": 0,
  "sort": "string"
}

PUT/api/v1/catalogs/patch/search

Updates all the patches based on the CVE IDs.

Request body: No parameters

Responses

Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found

Sample request

{
  "catalog_ids": [
    2001,
    2002
  ],
  "cve_ids": [
    "CVE-2014-0001",
    "CVE-2017-0022"
  ],
  "patch_types": [
    "BULLETIN",
    "ERRATA"
  ],
  "os": [
    "windows",
    "linux"
  ],
  "os_platform": [
    "x64",
    "x86"
  ],
  "os_version": [
    "2012 R2",
    "Red hat 6.5"
  ],
  "from": 0,
  "size": 100
}