Platform API 3.0
/
Reports

Mend API (3.0)

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 30 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.

If you have a dedicated instance of Mend, contact your Mend representative to access this API on your instance.

Download OpenAPI description
3.0.json
3.0.yaml
Languages
Servers
Generated server url

https://baseUrl/

Access Management

Operations

Administration - Groups

Operations

Administration - Users

Operations

Administration - Labels

Operations

Reports

Operations

Export Code Project Suppressions report asynchronously

Request

Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export Code Project Findings report asynchronously

Request

Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export Code Project Compliance report asynchronously

Request

Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
complianceStandardstring
reportLevelstring
descriptionstring
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "complianceStandard": "string",
  "reportLevel": "string",
  "description": "string",
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export Code Organization Compliance report asynchronously

Request

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
complianceStandardstring
reportLevelstring
descriptionstring
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "complianceStandard": "string",
  "reportLevel": "string",
  "description": "string",
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export Code Application Suppressions report asynchronously

Request

Path
applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export Code Application Findings report asynchronously

Request

Path
applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export Code Application Compliance report asynchronously

Request

Path
applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
complianceStandardstring
reportLevelstring
descriptionstring
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "complianceStandard": "string",
  "reportLevel": "string",
  "description": "string",
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Get Report Status

Request

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

reportUuidstringrequired

Asynchronous Process Status UUID

No request payload

Responses

OK

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

Delete Report

Request

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

reportUuidstringrequired

Asynchronous Process Status UUID

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(MessageDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "message": "Success!"
  }
}

Download Report

Request

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

reportUuidstringrequired

Asynchronous Process Status UUID

No request payload

Responses

OK

Get Reports

Request

Path
orgUuidstringrequired

org UUID (from the Mend App: Administration General > Organization UUID).

Query
cursorString

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.

limitstring<= 10000

Specifies the maximum number of items to be returned in the response.

Default "50"
No request payload

Responses

OK

Bodyapplication/json
additionalDataobject(Provides insights into endpoint-supported pagination information.)
  • totalItems: The total count of data points returned in an API response.
Example: {"totalItems":"422","next":"http://someUrl?cursor=3","cursor":3}
supportTokenstring(Support Token)
Example: "1171c60d"
responseArray of objects(ReportExportProcessDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Export project Due Diligence report asynchronously (Dependencies - SCA)

Request

Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export project SBOM report asynchronously (Dependencies - SCA)

Request

Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
reportTypestring
Enum"attribution""inventory""vulnerabilities""securityAlerts""sbom""securityAlertsLibrary""Compliance""Findings""Suppressions""spdx"
maxDepthLevelinteger(int32)
includeVulnerabilitiesboolean
isMlBomReportboolean
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "reportType": "attribution",
  "maxDepthLevel": 0,
  "includeVulnerabilities": true,
  "isMlBomReport": true,
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export application Due Diligence report asynchronously (Dependencies - SCA)

Request

Path
applicationIdentifierstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
projectUuidsArray of strings
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "projectUuids": [
    "string"
  ],
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Export application SBOM report asynchronously (Dependencies - SCA)

Request

Path
applicationIdentifierstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired
namestring
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
sendEmailNotificationboolean
labelsUuidListArray of strings
projectUuidsArray of strings
reportTypestring
Enum"attribution""inventory""vulnerabilities""securityAlerts""sbom""securityAlertsLibrary""Compliance""Findings""Suppressions""spdx"
maxDepthLevelinteger(int32)
includeVulnerabilitiesboolean
isMlBomReportboolean
additionalParamsobject
application/json
{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "projectUuids": [
    "string"
  ],
  "reportType": "attribution",
  "maxDepthLevel": 0,
  "includeVulnerabilities": true,
  "isMlBomReport": true,
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ReportExportProcessDTO)
Response
application/json
{
  "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": [ … ]
  }
}

Scans

Operations

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations

Integrations

Operations