Export Component Details V2

post

https://jf.example.com/xray/api/v2/component/exportDetails

Export component security details (vulnerabilities, violations, licenses, operational risks) to various formats. Returns a ZIP file containing the exported data. Requires Read permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

package_type

string

required

Package type of the component (e.g. docker, maven, npm).

component_name

string

required

Name of the component to export details for.

path

string

Path to the component in the repository.

output_format

string

Output format for the export (e.g. pdf).

spdx

boolean

Generate SPDX SBOM document.

spdx_format

string

SPDX output format (e.g. json, tag-value).

cyclonedx

boolean

Generate CycloneDX SBOM document.

cyclonedx_format

string

CycloneDX output format (e.g. json, xml).

vex

boolean

Generate VEX (Vulnerability Exploitability eXchange) document.

violations

boolean

Include violations in the export.

include_ignored_violations

boolean

Include ignored violations in the export.

license

boolean

Include license information in the export.

exclude_unknown

boolean

Exclude components with unknown licenses from the export.

vulnerabilities

boolean

Include security vulnerabilities information in the export.

operational_risk

boolean

Include operational risk information in the export.

secrets

boolean

Include information about secrets in the export.

services

boolean

Include information about services in the export.

malicious_code

boolean

Include malicious code findings in the export.

applications

boolean

Include information about applications in the export.

iac

boolean

Include Infrastructure as Code (IaC) findings in the export.

sast

boolean

Include Static Application Security Testing (SAST) findings in the export.

license_resolution

boolean

Include license conclusion/resolution in the export.

Responses

400

Invalid request payload.

500

Failed to export component details.

200ZIP file containing the exported component details.