patch-group-audit

In the Patch Management feature of Ivanti Neurons, a patch group audit enables you to retrieve the set of data items that represents all changes that have occurred to a given patch group. All patches added, removed, and group-level updates are available as documented patch group actions.

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 that will be returned as part of a successful patch-group-audit_get response.

Name

Type

 Description
actionDate Date The date time when the audit action occurred.
editedBy String The combined first and last name of the person or system that made the change.
notificationId String

The unique ID of the notification/bulletin associated with the patch. This value will be empty if the Action is GroupActivated, GroupArchived, GroupCreated or GroupRenamed.
notificationName String

The name of the notification/bulletin associated with the patch. This value will be empty if the Action is GroupActivated, GroupArchived, GroupCreated or GroupRenamed.
patchGroupAuditAction Enum The type of audit action this document reflects. Possible values:
  • PatchAdded = 0
  • PatchRemoved = 1
  • GroupCreated = 2
  • GroupRenamed = 3
  • GroupArchived = 4
  • GroupActivated = 5
patchGroupId Guid The unique patch group ID where the audit action took place.
patchGroupName String The name of the patch group, this will be updated and changed when the patchGroupAuditAction is GroupRenamed.
patchGroupStatus Enum The status of the patch group when the audit action occurred, either Active or Archived. For example, when the patchGroupAuditAction is GroupArchived, the value should be Archived. When the patchGroupAuditAction is GroupActivated, the value should be Active.
patchGroupVersion Int The patch group version where the audit action occurred.
patchName String The name of the patch which was added or removed. This value will be empty if the Action is GroupActivated, GroupArchived, GroupCreated or GroupRenamed.
patchUid Guid The patch ID of the patch which was added or removed. This value will be empty if the Action is GroupActivated, GroupArchived, GroupCreated or GroupRenamed.

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 group audit data from the last 60 days based on action date.