Endpoint: patch

In the Patch Management feature of Ivanti Neurons, Patch Settings enables you to configure patch configurations and patch groups for use in the cloud patch management workflow.

The patch endpoint enables you to retrieve the set of data items that represents a patch and its related metadata.

Required Header Parameters

Name Type Description

Authorization

Authheader

Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.

X-RapidAPI-Key

Enum

The key that applications and developers need to invoke the API.

X-RapidAPI-Host

String

The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com.

Optional Parameters

Name Type Description

Filter

String

An optional filter statement. There is no default.

OrderBy String If no sort value is provided, results are sorted by PublishedDate in descending order.
PageNumber Number The requested page number of the data result. If no value is provided, the default value is 1.
PageSize Number The requested page size of the data result. The maximum page size is 150. If no value is provided, the default value is 10.

Output Data Properties

The following set of data items represent a patch result that will be returned as part of a successful patch_get response.

Name

Type

Format

Description
affectedProducts Array of strings   Contains the list of affected product names.
cveCount Integer Int32 The number of CVEs.
cveExploited Array of strings   Collection of exploited CVE IDs. The Cve endpoint can be used to query for additional details about the CVEs.
deploymentId String Guid The deployment ID. The DeploymentHistory endpoint can be used to query for additional details about the deployment ID.
exploited Boolean  

This field is not filterable or sortable.

Specifies if the patch is exploited.

hasSupersedence Boolean   Specifies if the patch has supersedence.
informationalComment String   The informational comment about the patch.
kbNumber String   The KB number associated with the patch.
name String   The patch name.
notificationIds Array of strings   Contains the collection of notification IDs. The Notification endpoint can be used to query for additional details related to the notification IDs.
operatingSystem String   The operating system to which the patch applies.

patchId

String

Guid

The unique patch ID.

patchType

Integer

Int32

The patch type.

products

Array of strings

 

This complex field is not filterable or sortable.

The list of products associated with this patch.

releasedDate

String

Date-time

The date and time that the patch was released.

reliability

Object

 

This complex field is not filterable or sortable.

The global reliability metrics. It will specify the number of:

  • successfulInstalls
  • failedInstalls

restartRequired

Boolean

 

Specifies if a restart of the machine is required to successfully install this patch.

riskSenseExploited

Boolean

 

This field is not filterable or sortable.

Specifies if this patch is RiskSense exploited.

severity

Integer

Int32

The patch severity.

sideloadRequired

Boolean

 

Specifies if the patch must be sideloaded (manually downloaded).

supersededPatches

Array

 

This complex field is not filterable or sortable.

The list of patches that this patch supersedes.

supersededByPatches

Array

 

This complex field is not filterable or sortable.

The list of patches that supersede this patch.

symptomWorkarounds

Array

 

This complex field is not filterable or sortable.

The list of published symptom workarounds for the patch.

trendingScore

Integer

Int32

The trending score.

updated

String

Date-time

The date and time this patch was last updated.

vendorName

String

 

The name of the vendor who issued the patch.

Default Filter and Sort Behavior

The API will not return all records. If no filter and sort criteria are provided, this endpoint returns all patch data from the last 60 days based on released date.