Skip to content
Platform API 3.0
/
/
Export project Risk repor...

Export project Risk report asynchronously (Dependencies - SCA)

Request

Generates a Dependencies Risk report for the specified project asynchronously. Default export mode is Split (PDF summary + Excel CVE detail delivered as a ZIP). Full PDF mode is also available, subject to a project-count threshold.

Security
bearer-key
Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring

Output file format. The Risk report only supports pdf.

Value:"pdf"
Example:"pdf"
sendEmailNotificationboolean
exportModestring

Export mode. "split" (default) produces a ZIP (PDF summary + Excel CVE detail). "fullPdf" produces a single PDF, subject to a project-count threshold.

Enum:"split""fullPdf"
Example:"split"
POST
/api/v3.0/projects/{projectUuid}/dependencies/reports/risk
{
  "name": "string",
  "format": "pdf",
  "sendEmailNotification": true,
  "exportMode": "split"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example:"1171c60d"
responseobject(ReportExportProcessDTO)
Response
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "string",
    "name": "string",
    "scopeUuid": "string",
    "scopeName": "string",
    "subScopes": [ … ],
    "title": "string",
    "reportType": "attribution",
    "format": "json",
    "scopeType": "organization",
    "scopeUuidList": [ … ],
    "projectUuids": [ … ],
    "status": "PENDING",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "sendEmailNotification": true,
    "labelsUuidList": [ … ],
    "includeVulnerabilities": true,
    "excludeInactiveProjects": true
  }
}