Groups Api Get Group Pending Changes
Compares the compiled staged state with the live published bundle. Read-only. Requires the ADMIN or SECURITY_OPERATOR role.
Security Group id
1
200 OK successful response envelope. The changes pending publication for the Group
{
"groupId": 1,
"groupName": "Production Servers",
"hasPendingChanges": true,
"isNeverPublished": false,
"hasNetChanges": true,
"currentPublishedVersion": 3,
"publishedRuleCount": 20,
"stagedRuleCount": 20,
"changes": [
{
"changeType": "RULE_CHANGED",
"ruleId": 7,
"ruleName": "Audit Shell Spawn",
"ruleType": "PATH_FILE_CMD",
"action": "AUDIT",
"isBuiltIn": false,
"policyId": 2,
"policyName": "Production Policy",
"fromRevision": 1,
"toRevision": 2,
"fromPosition": 16,
"toPosition": 16,
"changedAspects": [
"ACTION"
],
"fromAction": "BLOCK",
"toAction": "AUDIT"
}
],
"mfaCredentialChanges": [],
"affectedPolicies": [
{
"policyId": 2,
"policyName": "Production Policy",
"reason": "UPDATED"
}
],
"policiesAwaitingPublish": [
{
"policyId": 2,
"policyName": "Production Policy"
}
]
}
Identifier of the Group
Current name of the Group
The Group's stored flag (see hasPendingChanges of the Group). It can be true while hasNetChanges is false
No published row or an empty payload; changes is then empty
True when a Publish would send something other than the live bundle: changes or mfaCredentialChanges is not empty. For a Group that was never published, true when the staged state has at least one rule or credential change
The Group's current policy version, the version of its live bundle. A Group never published has a version but no bundle
Number of rules in the live bundle; 0 when the Group was never published
Number of rules a Publish would compile now
Differences between the live bundle and the staged rules: for each staged rule in staged order its RULE_ADDED, or its RULE_CHANGED and then its ORDER_CHANGED, followed by the RULE_REMOVED items in live order. Empty when the Group was never published
SSH MFA credentials the Publish would add, remove or rotate, sorted by username
Policies whose published version, attachment or stack rank differs from the last Group publish
Attached Policies with unpublished changes of their own; publish those Policies first
400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
403 Forbidden: FORBIDDEN
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
404 Not Found: SECURITY_GROUP_NOT_FOUND
"ApiErrorResponse Object"
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/groups/{id}/pending-changes