Security Alerts

Get Security Alerts

get

Get all Security Alerts in a configuration

Path parameters

configstringRequired

Responses

200

Security Alerts retrieved successfully

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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]"
      ]
    }
  ]
}

Modify Security Alerts

put

Update an existing set of Security Alerts for a configuration

Path parameters

configstringRequired

Bodyobject · SecurityAlert[]

idstringRequired

namestring · min: 1Required

server_groupsstring[]Required

List of attached Server Group IDs

dynamic_rulesstring[]Required

List of attached Dynamic Rule IDs

recipientsstring · email[] · min: 1Required

Responses

200

Security Alerts updated successfully

application/json

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

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 Security Alerts

post

Create complete set of Security Alerts for a configuration

Path parameters

configstringRequired

Bodyobject · SecurityAlert[]

idstringRequired

namestring · min: 1Required

server_groupsstring[]Required

List of attached Server Group IDs

dynamic_rulesstring[]Required

List of attached Dynamic Rule IDs

recipientsstring · email[] · min: 1Required

Responses

201

Security Alerts created successfully

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

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 Security Alerts

delete

Delete all Security Alerts in a configuration

Path parameters

configstringRequired

Responses

200

Security Alerts deleted successfully

application/json

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v4.0/conf/{config}/security-alerts HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get single Alert

get

Get an individual Alert from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Alert retrieved successfully

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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]"
  ]
}

Modify a single Alert

put

Update an individual Alert within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

idstringRequired

namestring · min: 1Required

server_groupsstring[]Required

List of attached Server Group IDs

dynamic_rulesstring[]Required

List of attached Dynamic Rule IDs

recipientsstring · email[] · min: 1Required

Responses

200

Alert updated successfully

application/json

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

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 single Alert

post

Create an individual Alert within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

idstringRequired

namestring · min: 1Required

server_groupsstring[]Required

List of attached Server Group IDs

dynamic_rulesstring[]Required

List of attached Dynamic Rule IDs

recipientsstring · email[] · min: 1Required

Responses

201

Alert created successfully

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

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 single Alert

delete

Delete an individual Alert from the specified configuration

Path parameters

configstringRequired

entry_idstringRequired

Responses

200

Alert deleted successfully

application/json

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v4.0/conf/{config}/security-alerts/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Security Alerts version list

get

Get list of versions of Security Alerts in a configuration

Path parameters

configstringRequired

Responses

200

Security Alerts version list retrieved successfully

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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 version of Security Alerts

get

Get a specific version of an Alert

Path parameters

configstringRequired

versionstringRequired

Responses

200

Alert version retrieved successfully

application/json

422

Validation Error

application/json

get

HTTPcURLJavaScriptPython

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]"
      ]
    }
  ]
}

Revert Security Alerts to the specified version

put

Set a previous Security Alerts version to be the current one

Path parameters

configstringRequired

versionstringRequired

Responses

200

Security Alerts reversion was successful

application/json

422

Validation Error

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v4.0/conf/{config}/security-alerts/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}