getMissingPatches

Use this method to request a list of missing patches that are associated to specific endpoints or a specific company.

General parameters

These are common parameters, available across all public API methods.

Parameter	Description	Included in request	Type	Values
`id`	This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking.	Mandatory	String	No additional requirements Example "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
`method`	The name of the method you are using to send the request.	Mandatory	String	Must be a valid method name. Example "method": "methodName"
`jsonrpc`	The version of JSON-RPC used by the request and the response.	Mandatory	Integer	Possible values: `2.0` Example "jsonrpc": "2.0"
`params`	An object containing the configuration of the request.	Mandatory	Object	No additional requirements. Example "params": {...}
Under the `params` object
`page`	The results page number.	Optional	Integer	Default value: `1`
`perPage`	The number of results displayed per page.	Optional	Integer	The upper limit is 100 items per page. Default value: `30`

Parameters

Parameter	Description	Included in request	Type	Values
`endpointsIds`	The ID of the endpoint for which you want to retrieve patch information for.	Mandatory Note Either the `endpointId` or the `companyId` parameter must be included in the request. The two are mutually exclusive	Array	No additional requirements. Example "endpointsIds": ["67bc4a36bf64962c160eb6e4", "67bc4a36bf64962c160eb6d6"],
`companyId`	The ID of the company for which you want to retrieve patch information for.		String	No additional requirements. Example "companyId": "63c6bb02e3cb799758020c99"
`filters`	Determines the type of patches should be included in the response.	Optional	Object	Default value: If this parameter is not included in the request, all filters will be returned, regardless of type of severity level. Example "filters":{ "type": 0, "severity": 1 },

Objects

`filters`

Parameter	Description	Included in request	Type	Values
`type`	The type of patches you want included in the response.	Optional	Integer	Possible values: `0` - Security patch `1` - Non security patch `2` - Manually approved patch Default value: if not included, all patch types are included in the response.
`severity`	The severity level of the patches you want included in the response	Optional	Integer	Possible values: `0` - None `1` - Low `2` - Moderate `3` - Important `4` - Critical `5` - Unassigned Default value: if not included, all patch severity levels are included in the response.

Parameter

Description

Included in request

Type

Values

type

The type of patches you want included in the response.

Optional

Integer

Possible values:

0 - Security patch
1 - Non security patch
2 - Manually approved patch

Default value: if not included, all patch types are included in the response.

severity

The severity level of the patches you want included in the response

Optional

Integer

Possible values:

0 - None
1 - Low
2 - Moderate
3 - Important
4 - Critical
5 - Unassigned

Default value: if not included, all patch severity levels are included in the response.

For more information on viewing patch settings, refer to Viewing patch details.

Return value

Attribute	Type	Description
`endpointId`	String	The ID of the endpoint the patches are missing from.
`name`	String	The name of the patch.
`releaseDate`	String	The date on which the patch was released.
`bulletinUrl`	String	The URL of the bulletin associated to this patch.
`cves`	Array of strings	A list of CVE IDs associated with the patch.
`kbNumber`	String	The Microsoft Knowledge Base (KB) article associated with this patch.
`vendorNames`	Array of strings	A list of vendors that are associated with the patch.
`operatingSystem`	Integer	The operating system where the patch applies. Possible values: `1` - Windows `2` - Linux `3` - Mac
`type`	The type of the patch.	The type of the patch. Possible values: `0` - Security patch `1` - Non security patch `2` - Manually approved patch

Example

Request:

Request a list of patches for a specific company:

  {
       "params": {
            "companyId": "67bc4346c9c8243e9c0f6314",
            "filters":{
                "type": 0,
                "severity": 1
            },
            "page": 1,
            "perPage": 5
       },
       "jsonrpc": "2.0",
       "method": "getMissingPatches",
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
  }

Request a list of patches for a list of endpoints:

 {
       "params": {
            "filters":{
                "type": 1
            },
            "page": 2
       },
       "jsonrpc": "2.0",
       "method": "getMissingPatches",
       "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b"
  }

Response:

{
    "id": "301f7b05-ec02-481b-9ed6-c07b97de2b7b",
    "jsonrpc": "2.0",
    "result": {
        "items": [
            {
                "endpointId": "67bc4a36bf64962c160eb6e0",
                "name": "Windows6.0-SP2-KB973768-x64.msu",
                "releaseDate": null,
                "bulletinUrl": "http://technet.microsoft.com/security/bulletin/ms09-037",
                "cves": [
                    "CVE-2008-0015",
                    "CVE-2009-0901",
                    "CVE-2009-2493",
                    "CVE-2009-2494",
                    "CVE-2008-0020"
                ],
                "kbNumber": "Q973768",
                "vendorNames": [
                    "Microsoft"
                ],
                "operatingSystem": 1,
                "type": 0
            }
        ],
        "total": 99,
        "page": 1,
        "perPage": 1,
        "pagesCount": 99
    }
}

In this section: