Export application Findings report asynchronously (Dependencies

Platform API 3.0

Export application Findings report asynchronously (Dependencies - SCA)

Request

Generates a Dependencies Findings report for the specified application asynchronously. Supported formats: Excel, JSON, XML.

Security

bearer-key

Path

applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired

namestring

formatstring

Output file format. The Findings report supports excel, json and xml.

Enum:"excel""json""xml"

Example:"excel"

sendEmailNotificationboolean

projectUuidsArray of strings

vulnerabilitiesStateArray of strings

Alert states to include. Defaults to [OPEN] when omitted.

Example:

[
  "OPEN"
]

vulnerabilityTypesArray of strings

Filter by one or more vulnerability types. ANY (default) includes all types.

Example:

[
  "CVE",
  "GHSA"
]

dateRangeinteger, (int32)

Include only vulnerabilities first detected within the last N days. 0 or omitted means no date filter.

Example:30

zeroDayIdentifierstring

Scope the report to a specific zero-day event, by event UUID or name.

POST

/api/v3.0/applications/{applicationUuid}/dependencies/reports/findings

{
  "name": "string",
  "format": "excel",
  "sendEmailNotification": true,
  "projectUuids": [
    "string"
  ],
  "vulnerabilitiesState": [
    "OPEN"
  ],
  "vulnerabilityTypes": [
    "CVE",
    "GHSA"
  ],
  "dateRange": 30,
  "zeroDayIdentifier": "string"
}

Responses

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
  }
}