UpdateAggregateAlert is used to input data to update an aggregate alert.

Table: UpdateAggregateAlert

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 23, 2024
actionIdsOrNames[string]yes List of ids or names for actions to fire on query result. Actions in packages can be referred to as 'packagescope/packagename:actionname'.
enabledbooleanyes Flag indicating whether the aggregate alert is enabled.
descriptionstring  Description of the aggregate alert.
idstringyes The unique identifier of the aggregate alert.
labels[string]yes Labels attached to the aggregate alert.
namestringyes Name of the aggregate alert.
queryOwnershipTypeQueryOwnershipTypeyes Ownership of the query run by this aggregate alert. If value is User, ownership will be based on the runAsUserId field. See queryOwnershipType.
queryStringstringyes LogScale query to execute.
textQueryTimestampType  Timestamp type to use for a query. See QueryTimestampType.
runAsUserIdstring  The aggregate alert will run with the permissions of the user corresponding to this id if the queryOwnershipType field is set to User. If the queryOwnershipType is set to Organization, whilst runAsUserId is set, this will result in an error. If not specified, the aggregate alert will run with the permissions of the calling user. It requires the 'ChangeTriggersToRunAsOtherUsers' permission to set this field to a user id different from the calling user.
searchIntervalSecondslongyes Search interval in seconds. Valid values: 1-80 minutes in seconds divisible by 60 (60, 120, ..., 4800 seconds); 82-180 minutes in seconds divisible by 120 (4920, 5040, ..., 10800 seconds); and 4-24 hours in seconds divisible by 3600 (14400, 18000, ..., 86400 seconds).
throttleFieldstringyes A field to throttle on. Can only be set if throttleTimeSeconds is set.
throttleTimeSecondslongyes Throttle time in seconds.
triggerModeTriggerModeyes Trigger mode used for triggering the alert. See TriggerMode.
viewNameRepoOrViewNameyes Name of the view of the aggregate alert. RepoOrViewName is a scalar.