UpdateFilterAlert is used to input data for updating a filter alert

Table: UpdateFilterAlert

ParameterTypeRequiredDefaultStabilityDescription
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 Long-TermList of unique identifiers or names for actions to fire on query result. Actions in packages can be referred to as packagescope/packagename:actionname.
descriptionstring  Long-TermThe description of the filter alert.
enabledbooleanyes Long-TermWhether the filter alert is enabled.
idstringyes Long-TermThe unique identifier of the filter alert.
labels[string]yes Long-TermLabels attached to the filter alert.
namestringyes Long-TermThe name of the filter alert.
queryOwnershipTypeQueryOwnershipTypeyes Long-TermOwnership of the query run by this filter alert. If value is User, ownership will be based on the runAsUserId field. See QueryOwnershipType.
queryStringstringyes Long-TermLogScale query to execute.
runAsUserIdstring  Long-TermThe filter 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 filter 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.
throttleFieldstring  Long-TermA field to throttle on. Can only be set if throttleTimeSeconds is set.
throttleTimeSecondslong  Long-TermThe throttle time in seconds.
viewNamerepoOrViewNameyes Long-TermThe name of the view of the filter alert. repoOrViewName is a scalar.