Security Alerts
Get all Security Alerts in a configuration
GET /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]
}
Update an existing set of Security Alerts for a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
PUT /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 111
[
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]
{
"message": "Successfully updated entry"
}
Create complete set of Security Alerts for a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
POST /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 111
[
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]
{
"message": "Successfully created entry"
}
Delete all Security Alerts in a configuration
DELETE /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get an individual Alert from the specified configuration
GET /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
Update an individual Alert within a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
PUT /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
{
"message": "Successfully updated entry"
}
Create an individual Alert within a configuration
List of attached Server Group IDs
List of attached Dynamic Rule IDs
POST /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
{
"message": "Successfully created entry"
}
Delete an individual Alert from the specified configuration
DELETE /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully deleted entry"
}
Get list of versions of Security Alerts in a configuration
GET /api/v4.0/conf/{config}/security-alerts/versions HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"author": "text",
"email": "[email protected]",
"message": "text",
"date": "2025-07-11T03:30:36.040Z",
"version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
"parents": [
"f44073242093228b45bff7eb7a065559fa9b46aa"
]
}
]
}
Get a specific version of an Alert
GET /api/v4.0/conf/{config}/security-alerts/versions/{version} HTTP/1.1
Host:
Accept: */*
{
"total": 1,
"items": [
{
"id": "text",
"name": "text",
"server_groups": [
"text"
],
"dynamic_rules": [
"text"
],
"recipients": [
"[email protected]"
]
}
]
}
Set a previous Security Alerts version to be the current one
PUT /api/v4.0/conf/{config}/security-alerts/versions/{version}/revert HTTP/1.1
Host:
Accept: */*
{
"message": "Successfully updated entry"
}
Last updated
Was this helpful?