deployment-history

6 min

In the Patch Management feature of Ivanti Neurons, Deployment History provides a way to view the status of recent deployment operations. You can zero in on exceptions and quickly troubleshoot any issues.

The deployment-history endpoint enables you to retrieve the set of data items that represents a deployment history result.

HTTP Method

GET

Request URI

https://<hostname>/api/patch/content/v1/deployment-history?filter=machineName eq 'DESKTOP' and Status eq 3

Required Header Parameters

Name	Type	Description
Authorization	Authheader	Use the Bearer <access-token> value determined during the Authenticate to the Patch Management API process.

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.

Example Response

{
  "pageCount": 0,
  "currentPage": 0,
  "totalRecords": 0,
  "data": [
    {
      "deploymentId": "string",
      "deploymentStart": "2025-02-13T17:02:41.944Z",
      "deploymentStatus": "NotStarted",
      "discoveryId": "string",
      "elapsedTimeSeconds": 0,
      "machineName": "string",
      "notificationId": "string",
      "notificationName": "string",
      "notificationTitle": "string",
      "operatingSystem": "Any",
      "patchId": "string",
      "patchName": "string",
      "patchStatusReturnCode": "string",
      "productId": "string",
      "productName": "string",
      "patchKbNumber": "string",
      "patchReleaseDate": "2025-02-13T17:02:41.944Z",
      "policyGroupId": "string",
      "policyGroup": "string",
      "assignedPolicyId": "string",
      "assignedPolicy": "string"
    }
  ]

Output Data Properties

The following set of data items represent a deployment history result that will be returned as part of a successful deployment-history_get response.

Name	Type	Format	Description
assignedPolicy	String		The name of the assigned patch cloud policy.
assignedPolicyId	String	Guid	The ID of the assigned patch cloud policy.
deploymentId	String		The deployment ID.
deploymentStart	String	Date-time	The deployment start timestamp.
deploymentStatus	Enum		The status of the deployment. Possible values: NotStarted = 0, InProgress = 1, PendingReboot = 2, Success = 3, Failed = 4, TimedOut = 5 The deploymentStatus Enum output data property replaced the status String output data property. For example: https://{HostName}/api/patch/content/v1/deployment-history?filter=machineName eq 'DESKTOP' and Status eq 3 returns data for the deployment status "Success".
discoveryId	String		The discovery ID. The People and Devices API can be used to query for additional details about users and devices.
elapsedTimeSeconds	Integer	Int32	The elapsed time in seconds. The minimum is -2147483648. The maximum is 2147483647.
machineName	String		The name of the machine.
notificationId	String		The notification ID. The Notification endpoint can be used to query for additional details about the notification ID.
notificationName	String		The name of the notification
notificationTitle	String		The title of the notification
operatingSystem	Enum		The operating system of the device, for example Windows, Mac.
patchId	String	Guid	The patch ID. The Patch endpoint can be used to query for additional details about the patch ID.
patchKbNumber	String		The KB/external identifier of the related patch.
patchName	String		The patch name.
patchReleaseDate	Date		The release date of the related patch.
patchStatusReturnCode	String		The alpha numeric status return code returned for the deployed patch
policyName	String		The name of the policy assigned to the machine.
policyId	String		The ID of the policy assigned to the machine.
productId	String		The product ID.
productName	String		The product name.

Default Filter and Sort Behavior

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

Neurons API