Rules Api List Rule Ids
Ids of the Rules that match the same filters as the Rules list, with no page parameters, so a client can select every match across pages. Returns at most 500 ids (the most Rules one Policy can have attached) in the requested order, and truncated is true when more match. With assignable=true retired Rules are left out, because a Policy refuses them with 409 RULE_RETIRED. Read-only. Accessible to every authenticated role.
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
When true, retired Rules are left out because a Policy cannot take them (default false)
true
Field to sort by; decides which ids are kept when the list is cut at 500
name
Sort direction
ASC
200 OK successful response envelope. The ids of the matching Rules
{
"ids": [
7,
12,
31
],
"total": 3,
"limit": 500,
"truncated": false
}
Ids of the matching Rules in the requested order (default name ascending, then id), at most limit of them
Number of Rules that match the filter, whether or not they are all in ids
The most ids returned: the most Rules one Policy can have attached, as for SyncRulesRequest.ruleIdsInOrder
True when total is greater than the number of ids returned, so the list was cut at limit
400 Bad Request: INVALID_SORT or INVALID_FILTER
{
"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/ids