Rules Api List Rules
Lists every Rule (Built-in and Custom), paginated, filterable and sortable. Accessible to every authenticated role.
Zero-based page index (default 0). A negative page answers 400 INVALID_PAGINATION; it is not clamped.
Number of items per page (default 20, 1 to 100). A value outside 1 to 100 answers 400 INVALID_PAGINATION; it is not clamped.
20
Case-insensitive substring search matching name, description, or the match data of a user-defined rule (a built-in rule's body is never searched)
shell
Filter by rule type code (for example PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER, VIB_REPUTATION)
PATH_FILE_CMD
Filter by evaluation rank; case-insensitive
CUSTOM_LOCAL
true for Built-in, false for Custom
Filter by enabled or disabled status
true
Field to sort by
name
Sort direction
ASC
200 OK successful response envelope. A page of Rules
{
"items": [
{
"ruleId": 7,
"name": "Audit Shell Spawn",
"description": "Records every shell started by a service account",
"ruleType": "PATH_FILE_CMD",
"matchData": "{\"process_path\":\"/bin/sh\",\"match_mode\":\"EXACT\",\"allowed_ops\":[\"EXECUTE\"]}",
"action": "AUDIT",
"ruleRank": "CUSTOM_LOCAL",
"minAgentVersion": "1.0.0",
"guid": "00000000-0000-4000-8000-000000000007",
"isEnabled": true,
"isBuiltIn": false,
"revision": 1,
"createdBy": 1,
"updatedBy": 1,
"policyCount": 1,
"createdAt": "2026-01-10T08:00:00Z",
"updatedAt": "2026-01-10T08:00:00Z"
},
{
"ruleId": 10000001,
"name": "Block Credential Store Reads",
"description": "Stops reads of credential stores by unknown programs",
"ruleType": "PATH_FILE_CMD",
"matchData": null,
"action": "BLOCK",
"ruleRank": "VIRTUAL_PATCHING",
"minAgentVersion": "1.0.0",
"guid": "00000000-0000-4000-8000-000000000002",
"isEnabled": true,
"isBuiltIn": true,
"revision": 1,
"createdBy": 1,
"updatedBy": 1,
"policyCount": 2,
"createdAt": "2026-01-01T00:00:00Z",
"updatedAt": "2026-01-01T00:00:00Z"
},
{
"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": 2,
"createdAt": "2026-01-15T09:30:00Z",
"updatedAt": "2026-01-15T09:30:00Z"
},
{
"ruleId": 31,
"name": "Require MFA for SSH",
"description": "Asks the Production Operators for a second factor",
"ruleType": "MFA",
"matchData": "{\"user_group_ids\":[1]}",
"action": "MFA_REQUIRED",
"ruleRank": "CUSTOM_LOCAL",
"minAgentVersion": "1.0.0",
"guid": "00000000-0000-4000-8000-000000000031",
"isEnabled": true,
"isBuiltIn": false,
"revision": 1,
"createdBy": 1,
"updatedBy": 1,
"policyCount": 1,
"createdAt": "2026-01-12T08:00:00Z",
"updatedAt": "2026-01-12T08:00:00Z"
}
],
"page": 0,
"pageSize": 20,
"totalItems": 4,
"totalPages": 1
}
Array of items for the current page
Zero-based current page number
Number of items requested per page
Total number of items matching filter criteria
Total number of available pages
400 Bad Request: INVALID_PAGINATION, INVALID_SORT, INVALID_FILTER or INVALID_RULE_RANK
{
"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.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/rules