RulePackReviewDto

RulePackReviewDto
RulePackReviewDto

A stored review. It is the one pending review and expires 7 days after createdAt; fleet, coverage and attachedPolicyCount are computed when it is made.

JSON Example
{
    "reviewId": "string",
    "createdAt": "string",
    "expiresAt": "string",
    "packSequence": 0,
    "packVersion": "string",
    "artifactSha256": "string",
    "alreadyInstalled": false,
    "verification": {
        "signatureVerified": false,
        "signerFingerprint": "string",
        "signerSubject": "string",
        "timestampVerified": false,
        "signingTime": "string"
    },
    "fleet": [
        {
            "groupId": 0,
            "groupName": "string",
            "agents": 0,
            "belowMinAgentVersion": 0
        }
    ],
    "coverage": [
        {
            "groupId": 0,
            "groupName": "string",
            "agentsLosingRules": 0,
            "agentsNotCovered": 0
        }
    ],
    "diff": {
        "added": 0,
        "updated": 0,
        "retired": 0,
        "retireNotPresent": 0,
        "unchanged": 0
    },
    "builtInInUse": 0,
    "retirementNeedsConfirmation": false,
    "changes": [
        {
            "guid": "string",
            "ruleId": 0,
            "name": "string",
            "changeType": "string",
            "aspects": [
                "string"
            ],
            "ruleType": "string",
            "ruleRank": "string",
            "action": "string",
            "minAgentVersion": "string",
            "revision": 0,
            "attachedPolicyCount": 0
        }
    ]
}
string As uuid As uuid
reviewId
Required  

Identifier of the stored review; pass it to the install and discard operations

string As date-time As date-time
createdAt
Required  

When the review was made, as an ISO 8601 date-time in UTC

string As date-time As date-time
expiresAt
Required  

Seven days after createdAt, as an ISO 8601 date-time in UTC; installing a review past this time is refused with REVIEW_EXPIRED

integer As int64 As int64
packSequence
Required  

Sequence number of the reviewed pack, from its manifest

string
packVersion
Required  

Version text of the reviewed pack, from its manifest

string As ^[0-9a-f]{64}$
artifactSha256
Required  

SHA-256 of the reviewed rulepack.bin: pass it unchanged as the install request artifactSha256

boolean
alreadyInstalled
Required  

True when the install ledger already records this exact pack; installing it then answers ALREADY_INSTALLED and writes nothing

verification
Required  

What verified the pack. For an unsigned pack both flags are false and the three signer values are null.

fleet
Required  

One item per Security Group in id order, Groups without agents included: the Group's agents against the pack

coverage
Required  

One item per Security Group in id order, Groups without agents included: the Group's coverage change

diff
Required  

The plan's counts as the review shows them.

integer As int64 As int64
builtInInUse
Required  

Built-in Rules in use before the install

boolean
retirementNeedsConfirmation
Required  

The pack retires more than half of the Built-in Rules in use: the install needs confirmRetirement true

changes
Required  

The rules the install adds or updates, in pack entry order, then the rules it retires, in manifest order. Unchanged entries are only counted in diff