Alert Rules Operations List

Alert Rules Operations List
List all configured Alert Rules

List all configured Alert Rules. Accessible to ADMIN, SECURITY_OPERATOR, and AUDITOR.

Request
URI
GET
https://{api_host}/api/v1/alert-rules
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. Every configured alert rule with its delivery destination

[
    {
        "id": "1",
        "alertRuleId": 1,
        "name": "Protection Rule action = Block",
        "trigger": "Outcome = Enforced (blocked)",
        "triggerType": "OUTCOME",
        "triggerValue": "PREVENTED",
        "scope": "All Hypervisors",
        "groupScopeId": null,
        "threshold": "Any occurrence",
        "thresholdCount": 1,
        "thresholdWindow": "ANY_OCCURRENCE",
        "delivery": "Email · [email protected]",
        "deliveryType": "EMAIL",
        "recipient": "[email protected]",
        "enabled": true,
        "revision": 1,
        "ruleSource": "SYSTEM",
        "systemKey": "SYS_RULE_OUTCOME_PREVENTED",
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z"
    },
    {
        "id": "2",
        "alertRuleId": 2,
        "name": "Agent tampering detected",
        "trigger": "Tamper Attempt (TAMPER)",
        "triggerType": "EVENT_CLASS",
        "triggerValue": "TAMPER",
        "scope": "All Hypervisors",
        "groupScopeId": null,
        "threshold": "Any occurrence",
        "thresholdCount": 1,
        "thresholdWindow": "ANY_OCCURRENCE",
        "delivery": "Email · [email protected]",
        "deliveryType": "EMAIL",
        "recipient": "[email protected]",
        "enabled": true,
        "revision": 1,
        "ruleSource": "SYSTEM",
        "systemKey": "SYS_RULE_TAMPER_DETECTED",
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z"
    },
    {
        "id": "3",
        "alertRuleId": 3,
        "name": "Repeated configuration mutation",
        "trigger": "Configuration Mutation (CONFIG)",
        "triggerType": "EVENT_CLASS",
        "triggerValue": "CONFIG",
        "scope": "All Hypervisors",
        "groupScopeId": null,
        "threshold": "5 in 1 minute",
        "thresholdCount": 5,
        "thresholdWindow": "ONE_MINUTE",
        "delivery": "Email · [email protected]",
        "deliveryType": "EMAIL",
        "recipient": "[email protected]",
        "enabled": true,
        "revision": 1,
        "ruleSource": "SYSTEM",
        "systemKey": "SYS_RULE_CONFIG_MUTATION",
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z"
    },
    {
        "id": "4",
        "alertRuleId": 4,
        "name": "License expiration",
        "trigger": "License expiration",
        "triggerType": "LICENSE_EXPIRY",
        "triggerValue": "90,60,30,7,1",
        "scope": "All Hypervisors",
        "groupScopeId": null,
        "threshold": "Any occurrence",
        "thresholdCount": 1,
        "thresholdWindow": "ANY_OCCURRENCE",
        "delivery": "Email · [email protected]",
        "deliveryType": "EMAIL",
        "recipient": "[email protected]",
        "enabled": true,
        "revision": 1,
        "ruleSource": "SYSTEM",
        "systemKey": "SYS_RULE_LICENSE_EXPIRING",
        "createdAt": "2026-01-01T00:00:00Z",
        "updatedAt": "2026-01-01T00:00:00Z"
    },
    {
        "id": "5",
        "alertRuleId": 5,
        "name": "Repeated blocked actions in Production",
        "trigger": "Outcome = Enforced (blocked)",
        "triggerType": "OUTCOME",
        "triggerValue": "PREVENTED",
        "scope": "Production Servers",
        "groupScopeId": 1,
        "threshold": "5 in 5 minutes",
        "thresholdCount": 5,
        "thresholdWindow": "FIVE_MINUTES",
        "delivery": "Email · [email protected]",
        "deliveryType": "EMAIL",
        "recipient": "[email protected]",
        "enabled": true,
        "revision": 1,
        "ruleSource": "CUSTOM",
        "systemKey": null,
        "createdAt": "2026-01-16T10:00:00Z",
        "updatedAt": "2026-01-16T10:00:00Z"
    }
]
array of object
Optional

Full presentation model for an Alert Rule


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.


403

403 Forbidden: 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)

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/alert-rules