Patch Management API Overview

The Ivanti Neurons for Patch Management API is currently in Beta.

This guide describes the basic information you need to get up and running with the Ivanti Neurons for Patch Management API. It is assumed that you have some prior experience using a REST API.

The Ivanti Neurons for Patch Management API provides access to the Patch Management feature in Ivanti Neurons. The API is used to support the use of third-party reporting tools.

The Patch Management API on the Ivanti Developers Hub allows you to test API calls and to view sample code snippets and example responses.

Available Endpoints

The following are the endpoints with which you can interact.

  • Authentication: Enables you to retrieve the JWT access token.
  • Cve: Enables you to retrieve the set of data items that represents a CVE and its related metadata.
  • DeploymentHistory: Enables you to retrieve the set of data items that represents a deployment history result.
  • EndpointVulnerability: Enables you to retrieve the set of data items that represents an Endpoint Vulnerability device overview.
  • Notification: Enables you to retrieve the set of data items that represents a notification result, such as a security bulletin.
  • Patch: Enables you to retrieve the set of data items that represents a patch and its related metadata.

Relationships

The return code from certain calls can contain data that is related to other areas in the API. The following data fields have relationships with other endpoints.

Ivanti Neurons Patch Management API relationship diagram

Endpoint

Related Output Data Item

Cve

notificationsAffected: The Notifications endpoint can be used to query for additional details related to the notification ID.

patchesAffected: The Patch endpoint can be used to query for additional details related to specific patches.

DeploymentHistory

discoveryId: The People and Devices API. can be used to query for additional details about the users and devices.

notificationId: The Notifications endpoint can be used to query for additional details related to the notification ID.

patchId: The Patch endpoint can be used to query for additional details related to the patch ID.

EndpointVulnerability

discoveryId: The People and Devices API. can be used to query for additional details about the users and devices.

notificationsAffected: The Notifications endpoint can be used to query for additional details related to the notification ID.

patchesAffected: The Patch endpoint can be used to query for additional details related to specific patches.

Notification

cves: The Cve endpoint can be used to query for the list of CVEs addressed in the notification.

cvesExploited: The Cve endpoint can be used to query for collection of exploited CVEs.

Patch

cveExploited: The Cve endpoint can be used to query for additional details about the CVEs.

deploymentId: The DeploymentHistory endpoint can be used to query for additional details related to the deployment ID.

notificationIds: The Notifications endpoint can be used to query for additional details related to the notification IDs.

HTTP/HTTPS Methods

The following methods are currently supported and are used to denote actions against a resource.

  • GET: Reads a resource

Standard Status Codes

Conventional HTTP/HTTPS status codes are used to indicate the success or failure of an API request.

  • 200 indicates a successful response
  • 400 indicates a validation error has occurred. For more detailed information, see Response Codes.
  • 401 indicates the requestor is not authorized
  • 500 indicates an unexpected server error