Get Due Diligence Report Content

Xray REST APIs
Products
JFrog Xray
Content Type
REST API

Description: Get specific content in a Due Diligence report.

Since: 3.9

Security: Requires a user with the Manage Reports role.

Notes: For Xray version 3.21.2 and above with Projects, a Project Admin with Manage Security Assets privilege can get specific content in a Due Diligence report. using this REST API in the scope of a project, by using the additional query parameter projectKey.

Usage: POST /xray/api/v1/reports/licenses/{id}

Mandatory Pagination Parameters: You can order by

  • license

  • artifact

  • component

  • unknown_license

  • path

  • unrecognized

  • artifact_scan_time

  • custom, license_name

Sample Request

POST .../api/v1/reports/licenses?direction=asc&page_num=2&num_of_rows=10&order_by=license

Sample Response

{

"total_rows": 100,

"rows" :[
    {
        
        "license": "MIT",

        "license_name" : "The MIT License",
        "component": "deb://debian:buster:glibc:2.28-10,
        "artifact": "docker://redis:latest-07142020122937",
        "path": "repo1/folder1/artifact",

        "artifact_scan_time": "2020-07-14T09:32:00Z",

        "unknown" : false,

        "unrecognized" : false,

        "custom" : false,

        "references": [
            "https://spdx.org/licenses/AFL-1.1.html",
            "https://spdx.org/licenses/AFL-1.1"
        ]
    }
]

}

Get Due Diligence Report Content in Projects

POST /api/v1/reports/licenses?direction=asc&page_num=2&num_of_rows=10&order_by=license?projectKey=<project_key>