For the complete documentation index, see llms.txt. This page is also available as Markdown.

Exclusions Commands

getExclusions


Retrieves a list of issue exclusions. If no arguments are provided, all exclusions will be returned.

Arguments
Argument Name
Description
Required

filter_object

Filter object for the exclusion. Example: {"filter":{"AND":[{"SEARCH_FIELD":"alert_category","SEARCH_TYPE":"NEQ","SEARCH_VALUE":"Phishing"}]}}.

Optional

limit

Maximum number of exclusions to return. Default is 20.

Optional

Outputs

Core.Exclusion.ALERT_WHITELIST_ID number

Exclusion ID.

Core.Exclusion.ALERT_WHITELIST_MODIFY_TIME number

Exclusion modification time.

Core.Exclusion.ALERT_WHITELIST_NAME string

Exclusion name.

Core.Exclusion.ALERT_WHITELIST_HITS number

Exclusion hits count.

Core.Exclusion.ALERT_WHITELIST_COMMENT string

Exclusion comment.

Core.Exclusion.ALERT_WHITELIST_USER string

Exclusion user.

Core.Exclusion.ALERT_WHITELIST_PRETTY_USER string

Exclusion pretty user name.

Core.Exclusion.ALERT_WHITELIST_STATUS string

Exclusion status.

Core.Exclusion.ALERT_WHITELIST_BACKWARDS_SCAN_STATUS string

Exclusion backwards scan status.

Core.Exclusion.ALERT_WHITELIST_MIGRATED_FROM_ANALYTICS number

Whether the exclusion was migrated from analytics.

addExclusion


Adds an alert exclusion rule. Alerts matching the filter criteria will be suppressed moving forward.

Arguments
Argument Name
Description
Required

name

Name of the exclusion rule.

Required

filter_object

A JSON object defining the filter for the exclusion.

Required

status

The status of the exclusion rule. Possible values are: ENABLED, DISABLED. Default is ENABLED.

Optional

Outputs

Core.Exclusion.rule_id number

The ID of the created exclusion rule.

deleteExclusion


Deletes an alert exclusion rule. Alerts matching the filter criteria will be raised moving forward.

Arguments
Argument Name
Description
Required

alert_exclusion_id

The ID of the exclusion rule to delete.

Required

Outputs

Core.DeletedExclusion.rule_id number

The IDs of the deleted exclusion rules.


Last updated

Was this helpful?