Security Alerts

PreviousRate Limit Rules NextSecurity Policies

Last updated 4 months ago

Was this helpful?

Delete Security Alerts

delete

Delete all Security Alerts in a configuration

Path parameters

configstringrequired

Responses

application/json

delete

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/security-alerts'

200

422

{
  "message": "Successfully deleted entry"
}

Security Alerts deleted successfully

Get single Alert

get

Get an individual Alert from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

get

curl -L \
  --url '/api/v4.0/conf/{config}/security-alerts/{entry_id}'

200

422

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

Alert retrieved successfully

Delete single Alert

delete

Delete an individual Alert from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

delete

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/security-alerts/{entry_id}'

200

422

{
  "message": "Successfully deleted entry"
}

Alert deleted successfully

Get Security Alerts version list

get

Get list of versions of Security Alerts in a configuration

Path parameters

configstringrequired

Responses

application/json

get

curl -L \
  --url '/api/v4.0/conf/{config}/security-alerts/versions'

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "name@gmail.com",
      "message": "text",
      "date": "2025-04-11T19:48:37.455Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Security Alerts version list retrieved successfully

Get version of Security Alerts

get

Get a specific version of an Alert

Path parameters

configstringrequired

versionstringrequired

Responses

application/json

get

curl -L \
  --url '/api/v4.0/conf/{config}/security-alerts/versions/{version}'

200

422

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

Alert version retrieved successfully

Revert Security Alerts to the specified version

put

Set a previous Security Alerts version to be the current one

Path parameters

configstringrequired

versionstringrequired

Responses

application/json

put

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/security-alerts/versions/{version}/revert'

200

422

{
  "message": "Successfully updated entry"
}

Security Alerts reversion was successful

Get Security Alerts

get

Get all Security Alerts in a configuration

Path parameters

configstringrequired

Responses

application/json

get

curl -L \
  --url '/api/v4.0/conf/{config}/security-alerts'

200

422

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

Security Alerts retrieved successfully

Modify Security Alerts

put

Update an existing set of Security Alerts for a configuration

Path parameters

configstringrequired

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

application/json

put

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/security-alerts' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "text",
      "name": "text",
      "server_groups": [
        "text"
      ],
      "dynamic_rules": [
        "text"
      ],
      "recipients": [
        "name@gmail.com"
      ]
    }
  ]'

200

422

{
  "message": "Successfully updated entry"
}

Security Alerts updated successfully

Create Security Alerts

post

Create complete set of Security Alerts for a configuration

Path parameters

configstringrequired

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

application/json

post

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/security-alerts' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "id": "text",
      "name": "text",
      "server_groups": [
        "text"
      ],
      "dynamic_rules": [
        "text"
      ],
      "recipients": [
        "name@gmail.com"
      ]
    }
  ]'

201

422

{
  "message": "Successfully created entry"
}

Security Alerts created successfully

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

application/json

put

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/security-alerts/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "server_groups": [
      "text"
    ],
    "dynamic_rules": [
      "text"
    ],
    "recipients": [
      "name@gmail.com"
    ]
  }'

200

422

{
  "message": "Successfully updated entry"
}

Alert updated successfully

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

application/json

post

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/security-alerts/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "name": "text",
    "server_groups": [
      "text"
    ],
    "dynamic_rules": [
      "text"
    ],
    "recipients": [
      "name@gmail.com"
    ]
  }'

201

422

{
  "message": "Successfully created entry"
}

Alert created successfully