Create Ignore Rule

Creates an Ignore Rule that suppresses violations matching the specified filters. Ignore rules apply only to future scans. To apply to past scans, you must manually trigger Apply on Existing Content on the relevant watch or watches.

The ignore_filters object defines what to ignore. You must specify at least one objective filter (vulnerabilities, licenses, cves, operational_risk, or exposures) and can optionally scope it with source filters (components, artifacts, builds, etc.).

Requires the "Manage Watches" permission. Since Xray 3.11.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

When provided, the ignore rule is created in the scope of the specified project.

Body Params

Request body for creating an ignore rule. Must include notes and an ignore_filters object with at least one objective filter.

string
required

Free-text note explaining why this rule was created.

date-time

Optional expiration date in RFC 3339 format. After this date the rule is marked as expired and stops suppressing violations.

ignore_filters
object
required

Filters that define what to ignore. Combine objective filters (what issue type) with optional scope filters (where to apply). At least one objective filter is required.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json