RulePackChangeDto

RulePackChangeDto
RulePackChangeDto

One rule the install changes. Headers only, never a rule body.

JSON Example
{
    "guid": "string",
    "ruleId": 0,
    "name": "string",
    "changeType": "string",
    "aspects": [
        "string"
    ],
    "ruleType": "string",
    "ruleRank": "string",
    "action": "string",
    "minAgentVersion": "string",
    "revision": 0,
    "attachedPolicyCount": 0
}
string
guid
Required  

The rule's guid, the identity a Rule Pack uses to recognise a rule

integer As int64 As int64
ruleId
Required  

Identifier of the rule

string
name
Required  

The pack entry's name; for RETIRED the stored rule's name

changeType
Required  

What the install does to a rule.

  • ADDED: No rule has the entry's guid: a new Built-in Rule at revision 1, attached to no Policy
  • UPDATED: A Built-in Rule has the guid and at least one aspect differs: updated in place, revision plus 1
  • RETIRED: The pack's retire list names a Built-in Rule in use: retired, revision plus 1
Enumeration: ADDED, UPDATED, RETIRED
aspects
Required  

Empty for ADDED and RETIRED

string
ruleType
Required  

Rule type code of the rule: PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER or VIB_REPUTATION in this release; a pack entry naming a type outside the rule type catalog is refused

string
ruleRank
Required  

Rule rank name from the pack entry; for RETIRED the stored rule's

string
action
Required  

Default action of the rule: ALLOW, BLOCK or AUDIT for an added or updated rule (AUDIT is not valid for VIB_REPUTATION); a retired rule shows its stored action, which can also be MFA_REQUIRED

string
minAgentVersion
Required  

Minimum agent version as dotted version text, from the pack entry; for RETIRED the stored rule's

integer As int32 As int32
revision
Required  

The rule's revision after the install

integer As int64 As int64
attachedPolicyCount
Required  

Policies the rule is attached to now; 0 for ADDED