Software Secure Workload
Activity Configure

Create an Alert

This endpoint is used to create a new alert.

POST openapi/v1/alert_confs

Parameters:

Attribute

Type

Description

app_name

string

Application name associated with the alert configuration.

rules

object

Set of conditions that must be met for the alert configuration to trigger an alert.

subjects

object

List of users who should receive the alert.

severity

string

Indicates the level of severity associated with an alert configuration.

individual_alert

boolean

Indicates whether individual alerts should be sent that triggers the alert configuration.

summary_alert_freq

string

Frequency of summary alerts to be sent for a particular alert configuration.

alert_type

string

Unique identifier of the alert configuration.

app_instance_id

string

Unique identifier of a particular instance associated with the alert configuration.

The requesting user must have access to the provided scope. An alert without a scope is a ‘Service Provider Alert’ and only a site admin may create them.

Response object: Returns the newly created alert object.