Mend Reports API
The Reports API from Mend — 43 operation(s) for reports.
The Reports API from Mend — 43 operation(s) for reports.
openapi: 3.0.1
info:
title: Mend Access Management Reports API
description: 'Mend''s enhanced API enables automation of workflows in a REST compliant format. The API features:
+ Access for any user with Mend credentials, via a user key available in the user''s profile page in the Mend Platform.
+ Improved security with a JWT token per organization, which expires every 10 minutes.
+ Added scalability with support for cursor pagination and limiting results size.
+ Broader functionality available programmatically.
+ New standard API documentation for easy navigation and search.
**Note:** To help you get started with the Mend API 3.0, we recommend reviewing our onboarding guide -> [Getting Started with API 3.0](https://docs.mend.io/platform/latest/getting-started-with-mend-api-3-0).
This resource covers initial setup, authentication instructions, and helpful tips to help you successfully begin working with the Mend API 3.0. If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.'
version: '3.0'
servers:
- url: https://baseUrl
description: Generated server url
security:
- bearer-key: []
tags:
- name: Reports
paths:
/api/v3.0/applications/{applicationUuid}/ai/reports/findings:
post:
tags:
- Reports
summary: Export AI Application Findings report asynchronously
operationId: exportAiFindingsReport_2
parameters:
- name: applicationUuid
in: path
description: application UUID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/ai/reports/inventory:
post:
tags:
- Reports
summary: Export AI Application Inventory report asynchronously
operationId: exportAiInventoryReport_2
parameters:
- name: applicationUuid
in: path
description: application UUID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/code/reports/compliance:
post:
tags:
- Reports
summary: Export Code Application Compliance report asynchronously (Code - SAST)
operationId: exportCodeComplianceReport_1
parameters:
- name: applicationUuid
in: path
description: Application UUID (Administration > Applications)
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CodeReportExportProcessDTOV3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/code/reports/findings:
post:
tags:
- Reports
summary: Export Code Application Findings report asynchronously (Code - SAST)
operationId: exportCodeFindingsReport_1
parameters:
- name: applicationUuid
in: path
description: Application UUID (Administration > Applications)
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/code/reports/resolved:
post:
tags:
- Reports
summary: Export Code Application Resolved Findings report asynchronously (Code - SAST)
operationId: exportCodeResolvedReport_1
parameters:
- name: applicationUuid
in: path
description: Application UUID (Administration > Applications)
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResolvedReportExportProcessDTOV3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/code/reports/suppressions:
post:
tags:
- Reports
summary: Export Code Application Suppressions report asynchronously (Code - SAST)
operationId: exportCodeSuppressionsReport_1
parameters:
- name: applicationUuid
in: path
description: Application UUID (Administration > Applications)
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/images/reports/SBOM:
post:
tags:
- Reports
summary: Export Image Application SBOM report asynchronously
operationId: exportImgSbomReport_2
parameters:
- name: applicationUuid
in: path
description: application UUID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/images/reports/attribution:
post:
tags:
- Reports
summary: Export IMG Application Attribution report asynchronously
operationId: exportImgAttributionReport_2
parameters:
- name: applicationUuid
in: path
description: application UUID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttributionImgReportExportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/applications/{applicationUuid}/images/reports/dueDiligence:
post:
tags:
- Reports
summary: Export IMG Application Due Diligence report asynchronously
operationId: exportImgFindingsReport_2
parameters:
- name: applicationUuid
in: path
description: application UUID.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/ai/reports/findings:
post:
tags:
- Reports
summary: Export AI Organization Findings report asynchronously
operationId: exportAiFindingsReport_1
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/ai/reports/inventory:
post:
tags:
- Reports
summary: Export AI Organization Inventory report asynchronously
operationId: exportAiInventoryReport_1
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/code/reports/compliance:
post:
tags:
- Reports
summary: Export Code Organization Compliance report asynchronously (Code - SAST)
operationId: exportSastAnalyticsReport
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CodeReportExportProcessDTOV3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/images/reports/SBOM:
post:
tags:
- Reports
summary: Export Image Organization SBOM report asynchronously
operationId: exportImgSbomReport_1
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/images/reports/attribution:
post:
tags:
- Reports
summary: Export IMG Organization Attribution report asynchronously
operationId: exportImgAttributionReport_1
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttributionImgReportExportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/images/reports/dueDiligence:
post:
tags:
- Reports
summary: Export IMG Organization Due Diligence report asynchronously
operationId: exportImgFindingsReport_1
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/reports:
get:
tags:
- Reports
summary: Get Reports
operationId: getReportStatusesMultiContext
parameters:
- name: cursor
in: query
description: Parameter indicates the starting point for retrieving results, the first call doesn't include a cursor parameter in the request, the API response includes the first set of results along with a cursor pointing to the last item retrieved.
allowEmptyValue: true
schema:
type: string
- name: limit
in: query
description: Specifies the maximum number of items to be returned in the response.
allowEmptyValue: true
schema:
maximum: 10000
type: string
default: '50'
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponsePageableV3ListReportExportProcessDTOV3'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/reports/download/{reportUuid}:
get:
tags:
- Reports
summary: Download Report
operationId: downloadReport
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
- name: reportUuid
in: path
description: Asynchronous Process Status UUID
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/reports/users-groups:
post:
tags:
- Reports
summary: Export Users and Groups report asynchronously (Platform)
operationId: exportUsersReport
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUsersReportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3UsersReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/orgs/{orgUuid}/reports/{reportUuid}:
get:
tags:
- Reports
summary: Get Report Status
operationId: getReportStatus
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
- name: reportUuid
in: path
description: Asynchronous Process Status UUID
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTOV3'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
delete:
tags:
- Reports
summary: Delete Report
operationId: deleteReport
parameters:
- name: orgUuid
in: path
description: 'org UUID (from the Mend App: **Administration** General > **Organization UUID**).'
required: true
schema:
type: string
- name: reportUuid
in: path
description: Asynchronous Process Status UUID
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3MessageDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/ai/reports/findings:
post:
tags:
- Reports
summary: Export AI Project Findings report asynchronously
operationId: exportAiFindingsReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/ai/reports/inventory:
post:
tags:
- Reports
summary: Export AI Project Inventory report asynchronously
operationId: exportAiInventoryReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/code/reports/compliance:
post:
tags:
- Reports
summary: Export Code Project Compliance report asynchronously (Code - SAST)
operationId: exportCodeComplianceReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CodeReportExportProcessDTOV3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/code/reports/findings:
post:
tags:
- Reports
summary: Export Code Project Findings report asynchronously (Code - SAST)
operationId: exportCodeFindingsReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/code/reports/resolved:
post:
tags:
- Reports
summary: Export Code Project Resolved Findings report asynchronously (Code - SAST)
operationId: exportCodeResolvedReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ResolvedReportExportProcessDTOV3'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/code/reports/suppressions:
post:
tags:
- Reports
summary: Export Code Project Suppressions report asynchronously (Code - SAST)
operationId: exportCodeSuppressionsReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateReportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/images/reports/SBOM:
post:
tags:
- Reports
summary: Export Image Project SBOM report asynchronously
operationId: exportImgSbomReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReportExportProcessDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
'403':
description: Forbidden
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
/api/v3.0/projects/{projectUuid}/images/reports/attribution:
post:
tags:
- Reports
summary: Export IMG Project Attribution report asynchronously
operationId: exportImgAttributionReport
parameters:
- name: projectUuid
in: path
description: UUID of the project
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AttributionImgReportExportDTO'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DWRResponseV3ReportExportProcessDTO'
'400':
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/DWRResponseBase'
# --- truncated at 32 KB (81 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mend/refs/heads/main/openapi/mend-reports-api-openapi.yml