Rules Api Create Rule
Creates a Custom Rule. minAgentVersion is never accepted. A missing or blank ruleType is 400 UNKNOWN_RULE_TYPE (ruleType is required); a matchData longer than 8192 characters is 400 INVALID_MATCH_DATA. Requires the ADMIN or SECURITY_OPERATOR role.
The new Custom Rule: name, an optional description, ruleType, matchData and action. minAgentVersion is not accepted.
Show optional properties
{
"name": "string",
"ruleType": "string",
"matchData": "string",
"action": "string"
}
{
"name": "Block Unapproved Scripts",
"description": "Blocks scripts executed from the temporary directory",
"ruleType": "PATH_FILE_CMD",
"matchData": "{\"target_path\":\"/tmp/\",\"match_mode\":\"PREFIX\",\"allowed_ops\":[\"EXECUTE\"],\"is_directory_recursive\":true}",
"action": "BLOCK"
}
Trimmed; letters, digits, space and - _ . : ( ) only (INVALID_RULE_NAME). Unique among all Rules ignoring case (DUPLICATE_RULE_NAME).
Optional free text. It is trimmed; longer than 2,000 characters after trimming is INVALID_DESCRIPTION. Absent or null stores no description
Rule type code; it must be an entry of the rule type catalog (PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER or VIB_REPUTATION in this release; UNKNOWN_RULE_TYPE otherwise) and cannot be changed later. The allowed action depends on the type; an MFA rule accepts MFA_REQUIRED, AUDIT or ALLOW, and its matchData selects Hypervisor MFA User Groups through user_group_ids or all users through all_users true
JSON-encoded match criteria for the rule type, at most 8192 characters (INVALID_MATCH_DATA when longer or invalid). For PATH_FILE_CMD, target_path and process_path must be absolute (start with '/') for match_mode PREFIX; each '|' part of a GLOB must start with '/', '', '?' or '{'; a REGEX must be a valid ECMAScript regular expression. With match_mode EXACT or absent, a value is read as the Agent reads it: a regex when it holds a regex metacharacter, else a glob when it holds '' or '?', else an exact path that must be absolute. argv_pattern and arg_pattern must be valid regular expressions when match_mode is REGEX or they hold a regex metacharacter. 'any' and '*' match anything (INVALID_MATCH_DATA otherwise)
Default verdict of a Rule. MFA_REQUIRED is accepted only for ruleType MFA (any other type is refused with 400 INVALID_RULE_ACTION).
ALLOW: The operation is permittedBLOCK: The operation is aborted with -EPERMAUDIT: The operation is logged and alerted, and execution is permittedMFA_REQUIRED: Triggers an interactive TOTP challenge through PAM; accepted only for ruleType MFA
201 Created successful response envelope. The created Rule
{
"ruleId": 12,
"name": "Block Unapproved Scripts",
"description": "Blocks scripts executed from the temporary directory",
"ruleType": "PATH_FILE_CMD",
"matchData": "{\"target_path\":\"/tmp/\",\"match_mode\":\"PREFIX\",\"allowed_ops\":[\"EXECUTE\"],\"is_directory_recursive\":true}",
"action": "BLOCK",
"ruleRank": "CUSTOM_LOCAL",
"minAgentVersion": "1.0.0",
"guid": "00000000-0000-4000-8000-000000000012",
"isEnabled": true,
"isBuiltIn": false,
"revision": 1,
"createdBy": 1,
"updatedBy": 1,
"policyCount": 0,
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z"
}
Identifier of the rule, never changed. A Custom Rule gets it from the Console (CUSTOM_LOCAL 1 to 999,999, CUSTOM_GLOBAL 1,000,000 to 9,999,999); a Built-in Rule gets it from its Rule Pack (VIRTUAL_PATCHING 10,000,000 to 99,999,999, DEFAULT_ATTACK and UNSPECIFIED 100,000,000 to 999,999,999)
A Custom Rule's name is stored trimmed and differs from every other Rule's name ignoring case
Free text; a Custom Rule's text is stored trimmed, at most 2,000 characters, and a whitespace-only text is stored as an empty string. Null when none was given
Rule type code, the key of a rule type catalog entry: PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER or VIB_REPUTATION in this release; further codes are added by new releases; fixed when the rule is created
JSON-encoded rule match criteria. Null for built-in system rules to prevent detection evasion.
Default verdict of a Rule. MFA_REQUIRED is accepted only for ruleType MFA (any other type is refused with 400 INVALID_RULE_ACTION).
ALLOW: The operation is permittedBLOCK: The operation is aborted with -EPERMAUDIT: The operation is logged and alerted, and execution is permittedMFA_REQUIRED: Triggers an interactive TOTP challenge through PAM; accepted only for ruleType MFA
Evaluation rank: CUSTOM_LOCAL (custom rules) first, then CUSTOM_GLOBAL (SHA-256 rules created from the file catalog), then VIRTUAL_PATCHING, then DEFAULT_ATTACK. It decides the order rules are sent to the agent, ahead of Policy stack rank and sequence.
UNSPECIFIED: Built-in Rules from a Rule Pack whose vendor rank is unsetCUSTOM_LOCAL: Custom rules created on the Rules page; the default for a Custom Rule and the highest priority. Rule ids 1 to 999,999CUSTOM_GLOBAL: Custom SHA-256 rules created from the file catalog, evaluated after CUSTOM_LOCAL. Rule ids 1,000,000 to 9,999,999VIRTUAL_PATCHING: Built-in Rules from a Rule Pack, evaluated after CUSTOM_GLOBAL. Rule ids 10,000,000 to 99,999,999DEFAULT_ATTACK: Built-in Rules from a Rule Pack, evaluated last. Rule ids 100,000,000 to 999,999,999
Never admin-supplied: stamped from the rule type's catalog baseline or a Rule Pack's metadata
Generated once on first insert; read-only, for correlation with the agent's rule header
Whether the rule is enabled. A new Custom Rule starts enabled; a Built-in Rule is always enabled and cannot be disabled
True for a rule installed from a Rule Pack, false for a rule created through the API. A Built-in Rule cannot be edited or deleted
Starts at 1 and grows by 1 each time the rule's content or enabled state changes; a Rule Pack update or retirement of a Built-in Rule also advances it
Identifier of the user who created the rule, or for a Built-in Rule of the administrator who installed its pack. Null when no user is recorded, as for a rule installed by the first-boot system install
Identifier of the user who last changed the rule (edit, enable or disable, Rule Pack update or retirement). Null when no user is recorded
Number of Policies the Rule is attached to
When the rule was created, as an ISO 8601 date-time with offset; never changes
When the rule was last updated, as an ISO 8601 date-time with offset
400 Bad Request: INVALID_RULE_NAME, DUPLICATE_RULE_NAME, UNKNOWN_RULE_TYPE, INVALID_RULE_ACTION, INVALID_MATCH_DATA, UNKNOWN_USER_GROUP or MALFORMED_REQUEST
{
"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 or CSRF_ERROR. CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"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.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name":"string","ruleType":"string","matchData":"string","action":"string"}' https://{api_host}/api/v1/rules