Description: Get a report's details by using a specific report ID.
Since: 3.73.x
Security: Requires a user with the Manage Reports role.
Usage: POST /xray/api/v1/reports/cveSearch/{id}
Pagination Query Parameters:
Parameter | Description |
|---|---|
direction | desc/asc |
page_num | Number of pages to present |
num_of_rows | Number of rows per page |
order_by | Order of presentation |
Required Parameters
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
filters | object <filters> | Optional | The filter for details |
filters
Parameter | Type | Mandatory/Optional | Description |
|---|---|---|---|
impacted_artifact | string | optional | Wildcard patterns for including artifact name. |
scan_date | string | optional | The start of the scan date range. This is a timestamp in RFC 3339 format: <YYY-MM-DDTHH-MM-SSZ>. |
vulnerable_component | string | optional | Wildcard patterns for including component name. |
Response Codes
Status Code | Description |
|---|---|
200 | OK |
201 | Created |
400 | Bad request |
404 | Report ID not found |
500 | server error |
Sample Request
{
"filters": {
"impacted_artifact": "*artifact*",
"scan_date": "2023-01-05T08:00:00Z",
"vulnerable_component": "*component*"
}
}
Sample Response
{
"cve": "CVE-2023-29402",
"total_rows": 1,
"produced_at": "2023-07-04T16:29:15+03:00",
"created_by": "admin",
"rows": [
{
"vulnerable_component": "go://github.com/golang/go:1.19.5",
"impacted_artifact": "docker://api-firewal:latest",
"path": "docker1/api-firewal/latest/",
"fixed_versions": [
"1.19.10",
"1.20.5"
],
"artifact_scan_time": "2023-07-04T16:27:34+03:00",
"package_type": "go",
"issue_id": "XRAY-521544",
"summary": "The CVE issue summary",
"severity": "Critical",
"cvss_v3_score": 9.8,
"cvss_v3_vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H",
"provider": "JFrog",
"description": "The CVE issue description",
"references": [
"https://go.dev/issue/60167",
"https://pkg.go.dev/vuln/GO-2023-1839"
],
"published": "2023-06-09T07:17:42+03:00"
}
]
}