Try JFrog
API Reference
Contact SupportTry JFrog
  1. Xray REST APIs
  2. Remediation V1

Get Vulnerability Remediation Options

post
https://jf.example.com/xray/api/v1/remediation

Returns upgrade and fix suggestions for a vulnerability on a scanned artifact. Suggestions come from the Catalog (lockfile, direct dependency, or base-image upgrades) and, when available, from JFrog Research text on the issue.

issue_id must be an Xray issue ID (for example XRAY-12345). A CVE identifier is rejected because impact paths are keyed by Xray ID.

Requires a user with Read permission. Advanced Security (JAS) must be enabled, the dependencies feature must be on, and Catalog must be reachable.

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

Request body for vulnerability remediation options. issue_id must be an Xray issue ID, not a CVE.

string

Component identifier of the scanned artifact (for example npm://lodash:4.17.20). Used to enrich first- and second-party application metadata on steps.

string
required

Xray issue ID to remediate. Must be an Xray ID (for example XRAY-12345). A CVE ID is rejected with HTTP 400 because impact paths are keyed by Xray ID.

string
required

Artifact path used to resolve the stored SBOM, including the Artifactory instance id as the first segment (for Xray 3.x this is typically default).

ecosystems
array of strings

Array of strings — Catalog ecosystems to search when looking up the package. Defaults to generic when omitted.

ecosystems
string
enum

Preferred upgrade strategy. Catalog still returns steps for every strategy; this value selects which strategy the computation favors.

Allowed:
Responses

Updated about 3 hours ago

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

Updated about 3 hours ago

Did this page help you?