The CreateFilterAlert input
includes various settings.
Table: CreateFilterAlert
| Parameter | Type | Required | Default | Stability | Description |
|---|---|---|---|---|---|
| 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: Mar 28, 2025 | |||||
actionIdsOrNames | [string] | yes | Long-Term | List of unique identifiers or names for actions to fire on query result. Actions in packages can be referred to as packagescope/packagename:actionname. | |
description | string | yes | Long-Term | Description of the filter alert. | |
enabled | boolean | true | Long-Term | Flag indicating whether the filter alert is enabled. | |
labels | [string] | yes | [ ] | Long-Term | Labels attached to the filter alert. |
name | string | yes | Long-Term | Name of the filter alert. | |
queryOwnershipType | QueryOwnershipType | yes | Long-Term | Ownership of the query run by this filter alert. If value is User, ownership will be based on the runAsUserId field. See QueryOwnershipType. | |
queryString | string | yes | Long-Term | LogScale query to execute. | |
runAsUserId | string | Long-Term | The 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. | ||
throttleField | string | Long-Term | A field to throttle on. Can only be set if throttleTimeSeconds is set. | ||
throttleTimeSeconds | long | Long-Term | Throttle time in seconds. | ||
viewName | repoOrViewName | yes | Long-Term | Name of the view of the filter alert. repoOrViewName is a scalar. | |