Export Component Details

Xray REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Export component details/Export SBOM as CycloneDX / SPDX

Security: Requires a valid user with "Read" permission

Usage: POST component/exportDetails

Consumes : application/json

Sample Request:

{
    "component_name": "image:tag",
    "package_type": "build | releaseBundle | docker | debian | npm | rpm | go | pypi | conan | terraform | alpine | nuget | cran | conan | maven",
    "sha_256" : "1d36301476dc57eb479e03d9e37a885dd751a6e6979f6f916a92c10cb7520e4e",
    "violations": true | false,
    "include_ignored_violations": true | false,            
    "license": true | false,
    "exclude_unknown": true | false,
    "security": true | false,
    "malicious_code": true | false,
    "iac": true | false,
    "services": true | false,
    "applications": true | false,
    "output_format": "pdf | csv | json | json_full",
    "spdx": true | false,
    "spdx_format": "json | tag:value | xlsx",
    "cyclonedx": true | false,
    "cyclonedx_format": "json | xml",
    "vex": true | false,
    "operational_risk": true | false
}

Note

For more information about operational risk, see Components Operational Risk.Components Operational Risk

Response:

[] byte stream to file

Response Codes:

200: Success

400: Invalid request payload

403: No Permission to component

500: Failed to export component details