[{"label":"Latest (v1)","version":"latest"}]
vrealize-log-insight-cloud-service

AlertDefinitionDto

Alert definition


Properties

string
name Required

Alert name


string
alertType Required

Type of alert

Possible values are: per-event/windowed


map of number as double
severityThreshold Required

Map of severity(CRITICAL, IMMEDIATE, WARNING, INFO) and threshold value


query Required

Query definition


integer as int64
periodInMillis Required

Time period that indicates how frequently the alert should be evaluated (in milliseconds)


string
operator Required

Condition for triggering the alert

Possible values are: GREATER_THANGREATER_THAN_EQUALLESS_THANLESS_THAN_EQUALEQUAL


map of string
alertMetadata Optional

Additional information associated with the alert


boolean
enabled Optional

Indicates whether the alert is enabled or disabled


entityTagAssociation Optional

List of tags associated with this alert


string
id Optional

Alert ID


integer as int64
lastUpdatedAt Optional

Timestamp at which the alert was last updated


logRcaConfig Optional

Lists the RCA parameters if Root Cause Analysis (RCA) is enabled, otherwise it’s null


array of string
emailRecipients Optional

Email recipients for the alert notifications


array of string
notificationConfigs Optional

Notification configs associated with the alert


notificationMetadata Optional

Custom fields or all logs corresponding to the alert included in the alert notification


string
description Optional

Alert description


string
cspOrgId Optional

Unique ID associated with the org


integer as int64
createdAt Optional

Timestamp at which the alert was created


string
recommendations Optional

Alert recommendations for troubleshooting


string
contentPackId Optional

ID of the content pack that the alert belongs to if the alert is part of a content pack


severityToNotificants Optional

Map of severity(CRITICAL, IMMEDIATE, WARNING, INFO) to the list of notification recipients (email and webhook)


integer as int64
snoozeEndTimeInMillis Optional

End time for snoozing the alert (in milliseconds)


integer as int64
snoozeStartTimeInMillis Optional

Start time for snoozing the alert (in milliseconds)


string
source Optional

Source of the alert

Possible values are: USER_DEFINED


number as double
threshold Optional

Minimum threshold for triggering the alert

JSON Example

{
	"alertType": "per-event/windowed",
	"name": "string",
	"operator": "GREATER_THAN",
	"periodInMillis": 0,
	"query": {
		"constraints": {
			"constraints": [
				{
					"fieldName": "text",
					"operator": "CONTAINS",
					"value": "error"
				}
			],
			"fieldName": "string",
			"operator": "AND",
			"value": "string"
		},
		"name": "string"
	},
	"severityThreshold": {
		"key": 0
	}
}
[{"label":"Latest (v1)","version":"latest"}]
vrealize-log-insight-cloud-service
Parameter To

Create Alert
Update Alert By Put
Returned By

Get Alerts
Create Alert
Get Alert By ID
Update Alert By Put

Feedback

Was this page helpful?