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, watches, etc.). Combining an objective filter with scope filters is supported, for example cves together with watches.

The optional expires_at field must be a future RFC 3339 timestamp (e.g., 2027-06-29T00:00:00Z). Past timestamps are rejected with a validation error.

Tip: when calling this endpoint with jf xr curl or another shell client, pass the JSON body via --data @file.json rather than an inline string to avoid quoting pitfalls — embedding single quotes inside a single-quoted argument produces invalid JSON, which fails with Failed to parse ignore rule.

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

The short identifier of a JFrog Project (the project key, not its display name). When provided, the ignore rule is created in the scope of the specified project and is automatically scoped to that project (effectively appended to ignore_filters.projects).

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. Must be a future timestamp at the time of creation; past timestamps are rejected with a validation error. 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