Rules Api List Rules

Rules Api List Rules
List Rules

Lists every Rule (Built-in and Custom), paginated, filterable and sortable. Accessible to every authenticated role.

Request
URI
GET
https://{api_host}/api/v1/rules
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default 0). A negative page answers 400 INVALID_PAGINATION; it is not clamped.

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Number of items per page (default 20, 1 to 100). A value outside 1 to 100 answers 400 INVALID_PAGINATION; it is not clamped.

pageSize example
20
string
search
Optional

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)

search example
shell
string
ruleType
Optional

Filter by rule type code (for example PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER, VIB_REPUTATION)

ruleType example
PATH_FILE_CMD
action
Optional

Filter by action

action example
ALLOW
ruleRank
Optional

Filter by evaluation rank; case-insensitive

ruleRank example
CUSTOM_LOCAL
boolean
isBuiltIn
Optional

true for Built-in, false for Custom

boolean
isEnabled
Optional

Filter by enabled or disabled status

isEnabled example
true
sortBy
Optional
Constraints: default: name

Field to sort by

sortBy example
name
sortOrder
Optional
Constraints: default: ASC

Sort direction

sortOrder example
ASC

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of Rules

Returns PaginatedResponse_RuleDto of type(s) application/json
{
    "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 object
items
Required  

Array of items for the current page

integer As int32 As int32
page
Required  
Constraints: minimum: 0

Zero-based current page number

integer As int32 As int32
pageSize
Required  
Constraints: minimum: 1 maximum: 100

Number of items requested per page

integer As int64 As int64
totalItems
Required  

Total number of items matching filter criteria

integer As int32 As int32
totalPages
Required  
Constraints: minimum: 0

Total number of available pages


400

400 Bad Request: INVALID_PAGINATION, INVALID_SORT, INVALID_FILTER or INVALID_RULE_RANK

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/rules