Security Alerts

PreviousRate Limit Rules NextSecurity Policies

Last updated 1 month ago

Was this helpful?

Get Security Alerts

Get all Security Alerts in a configuration

GET/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Response

Security Alerts retrieved successfully

Body

totalinteger

Example: 1

itemsarray of Security Alert

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "server_groups": [
        "text"
      ],
      "dynamic_rules": [
        "text"
      ],
      "recipients": [
        "name@gmail.com"
      ]
    }
  ]
}

Modify Security Alerts

Update an existing set of Security Alerts for a configuration

PUT/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Body

id*Id

name*Name

server_groups*Server Groups

List of attached Server Group IDs

dynamic_rules*Dynamic Rules

List of attached Dynamic Rule IDs

recipients*Recipients

Response

Security Alerts updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "server_groups": [
          "text"
        ],
        "dynamic_rules": [
          "text"
        ],
        "recipients": [
          "name@gmail.com"
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create Security Alerts

Create complete set of Security Alerts for a configuration

POST/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Body

id*Id

name*Name

server_groups*Server Groups

List of attached Server Group IDs

dynamic_rules*Dynamic Rules

List of attached Dynamic Rule IDs

recipients*Recipients

Response

Security Alerts created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "server_groups": [
          "text"
        ],
        "dynamic_rules": [
          "text"
        ],
        "recipients": [
          "name@gmail.com"
        ]
      }
    ]),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

Delete Security Alerts

Delete all Security Alerts in a configuration

DELETE/api/v4.0/conf/{config}/security-alerts

Path parameters

config*Config

Response

Security Alerts deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

Get single Alert

Get an individual Alert from the specified configuration

GET/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Alert retrieved successfully

Body

id*Id

name*Name

server_groups*Server Groups

List of attached Server Group IDs

dynamic_rules*Dynamic Rules

List of attached Dynamic Rule IDs

recipients*Recipients

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "name": "text",
  "server_groups": [
    "text"
  ],
  "dynamic_rules": [
    "text"
  ],
  "recipients": [
    "name@gmail.com"
  ]
}

Modify a single Alert

Update an individual Alert within a configuration

PUT/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

id*Id

name*Name

server_groups*Server Groups

List of attached Server Group IDs

dynamic_rules*Dynamic Rules

List of attached Dynamic Rule IDs

recipients*Recipients

Response

Alert updated successfully

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "server_groups": [
        "text"
      ],
      "dynamic_rules": [
        "text"
      ],
      "recipients": [
        "name@gmail.com"
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}

Create single Alert

Create an individual Alert within a configuration

POST/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Body

id*Id

name*Name

server_groups*Server Groups

List of attached Server Group IDs

dynamic_rules*Dynamic Rules

List of attached Dynamic Rule IDs

recipients*Recipients

Response

Alert created successfully

Body

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "server_groups": [
        "text"
      ],
      "dynamic_rules": [
        "text"
      ],
      "recipients": [
        "name@gmail.com"
      ]
    }),
});
const data = await response.json();

Response

{
  "message": "Successfully created entry"
}

Delete single Alert

Delete an individual Alert from the specified configuration

DELETE/api/v4.0/conf/{config}/security-alerts/{entry_id}

Path parameters

config*Config

entry_id*Entry

Response

Alert deleted successfully

Body

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully deleted entry"
}

Get Security Alerts version list

Get list of versions of Security Alerts in a configuration

GET/api/v4.0/conf/{config}/security-alerts/versions

Path parameters

config*Config

Response

Security Alerts version list retrieved successfully

Body

totalinteger

Example: 1

itemsarray of VersionEntry

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-01-30T14:35:53.364Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Security Alerts

Get a specific version of an Alert

GET/api/v4.0/conf/{config}/security-alerts/versions/{version}

Path parameters

config*Config

version*Version

Response

Alert version retrieved successfully

Body

totalinteger

Example: 1

itemsarray of Security Alert

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "total": 1,
  "items": [
    {
      "id": "text",
      "name": "text",
      "server_groups": [
        "text"
      ],
      "dynamic_rules": [
        "text"
      ],
      "recipients": [
        "name@gmail.com"
      ]
    }
  ]
}

Revert Security Alerts to the specified version

Set a previous Security Alerts version to be the current one

PUT/api/v4.0/conf/{config}/security-alerts/versions/{version}/revert

Path parameters

config*Config

version*Version

Response

Security Alerts reversion was successful

Body

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

const response = await fetch('/api/v4.0/conf/{config}/security-alerts/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Successfully updated entry"
}