Policies Api List Policy Rules

Policies Api List Policy Rules
List a Policy's Rules

Returns the Rules attached to the Policy in evaluation order. Accessible to every authenticated role.

Request
URI
GET
https://{api_host}/api/v1/policies/{id}/rules
COPY
Path Parameters
integer
id
Required  

Policy id

id example
3

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The Rules attached to the Policy

[
    {
        "policyId": 3,
        "ruleId": 31,
        "ruleName": "Require MFA for SSH",
        "ruleType": "MFA",
        "action": "MFA_REQUIRED",
        "ruleRank": "CUSTOM_LOCAL",
        "isBuiltIn": false,
        "isEnabled": true,
        "description": "Asks the Production Operators for a second factor",
        "matchData": "{\"user_group_ids\":[1]}",
        "revision": 1,
        "updatedAt": "2026-01-12T08:00:00Z",
        "sequence": 1
    },
    {
        "policyId": 3,
        "ruleId": 12,
        "ruleName": "Block Unapproved Scripts",
        "ruleType": "PATH_FILE_CMD",
        "action": "BLOCK",
        "ruleRank": "CUSTOM_LOCAL",
        "isBuiltIn": false,
        "isEnabled": true,
        "description": "Blocks scripts executed from the temporary directory",
        "matchData": "{\"target_path\":\"/tmp/\",\"match_mode\":\"PREFIX\",\"allowed_ops\":[\"EXECUTE\"],\"is_directory_recursive\":true}",
        "revision": 1,
        "updatedAt": "2026-01-15T09:30:00Z",
        "sequence": 2
    },
    {
        "policyId": 3,
        "ruleId": 7,
        "ruleName": "Audit Shell Spawn",
        "ruleType": "PATH_FILE_CMD",
        "action": "AUDIT",
        "ruleRank": "CUSTOM_LOCAL",
        "isBuiltIn": false,
        "isEnabled": true,
        "description": "Records every shell started by a service account",
        "matchData": "{\"process_path\":\"/bin/sh\",\"match_mode\":\"EXACT\",\"allowed_ops\":[\"EXECUTE\"]}",
        "revision": 1,
        "updatedAt": "2026-01-10T08:00:00Z",
        "sequence": 3
    }
]
array of object
Optional

A Rule attached to a Policy, in evaluation order.


400

400 Bad Request: INVALID_ARGUMENT when the id path variable is not a number

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.


404

404 Not Found: POLICY_NOT_FOUND

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.


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