Get Ignore Rules

get

https://jf.example.com/xray/api/v1/ignore_rules

Returns all Ignore Rules matching the specified query filters. All filter parameters are optional. Use pagination parameters to control result size.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

vulnerability

string

Filter by vulnerability ID (XRAY-nnnnn).

cve

string

Filter by CVE ID.

license

string

Filter by license name.

policy

string

Filter by policy name.

watch

string

Filter by watch name.

component_name

string

Filter by component name.

component_version

string

Filter by component version.

artifact_name

string

Filter by artifact name.

artifact_version

string

Filter by artifact version.

artifact_path

string

Filter by artifact path.

build_name

string

Filter by build name.

build_version

string

Filter by build version.

release_bundle_name

string

Filter by release bundle name.

release_bundle_version

string

Filter by release bundle version.

docker_layer

string

Filter by Docker layer SHA.

exposures_scanner

string

Filter by exposure scanner ID.

exposures_category

string

Filter by exposure category.

exposures_file_path

string

Filter by exposure file path.

exposures_fingerprint

string

Filter by exposure fingerprint.

git_repository

string

Filter by git repository name.

expires_before

date-time

Filter rules expiring before this date (RFC 3339).

expires_after

date-time

Filter rules expiring after this date (RFC 3339).

order_by

string

Sort field. Valid values: external_id, author, created, expires_at, project_key. Default: created.

direction

string

enum

Sort direction. Default: asc.

Allowed:

page_num

integer

Page number (1-based).

num_of_rows

integer

Number of rows per page.

projectKey

string

Scope results to the specified project.

Responses

200Successfully retrieved ignore rules.

400Invalid query parameters.

500Internal server error.