Skip to content
Platform API 3.0
/
/
Get Security Alerts By Li...

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.

Note: To help you get started with the Mend API 3.0, we recommend reviewing our onboarding guide -> Getting Started with 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.

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

Scans

Operations

Get Project Scans

Request

Returns the project related scans

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

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(ScanSummaryDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Get Scan

Request

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ScanDTOV3)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "string",
    "name": "string",
    "engine": "UNIFIED",
    "status": "RUNNING",
    "projectId": 0,
    "productId": 0,
    "domainId": 0,
    "projectUuid": "string",
    "processUuid": "string",
    "hasViolations": true,
    "startTime": "2019-08-24T14:15:22Z",
    "endTime": "2019-08-24T14:15:22Z",
    "lastModified": "2019-08-24T14:15:22Z",
    "configurationName": "string",
    "reference": "string",
    "triggeredBy": "string",
    "agentInfo": { … }
  }
}

Get Scan Summary

Request

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ScanSummaryDTOV3)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "string",
    "name": "string",
    "processUuid": "string",
    "scanTime": "2019-08-24T14:15:22Z",
    "scanStatus": "string",
    "engine": "UNIFIED",
    "scanDuration": "string",
    "configurationName": "string",
    "reference": "string",
    "triggeredBy": "string",
    "agentName": "string",
    "agentVersion": "string",
    "supportToken": "string",
    "projectName": "string",
    "projectUuid": "string",
    "tags": [ … ],
    "applicationName": "string",
    "applicationUuid": "string",
    "workflowUuids": [ … ],
    "workflowNames": [ … ],
    "statistics": { … }
  }
}

Get Scan Tags

Request

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

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(ScanTagDTO)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Get Scan Security Findings

Request

Returns all security findings for a given scan

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

Query
limitstring<= 10000

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

Default "50"
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.

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(SecurityFindingDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Get Security Alerts By Library

Request

Returns all security alerts for a given scan, including library and severity information, arranged by library

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

Query
limitstring<= 10000

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

Default "50"
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.

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(LibrarySecurityFindingDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Get Root Libraries Security Finding

Request

Get root libraries security findings for a given scan

Security
bearer-key
Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

Query
limitstring<= 10000

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

Default "50"
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.

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(RootLibrarySecurityFindingDTOV3)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "next": "http://someUrl?cursor=3",
    "cursor": 3
  },
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations

User Management - Permissions

Operations

Integrations

Operations

Source Files

Operations

Reports - Account

Operations

Applications - SBOM Scans

Operations

Projects - SBOM Scans

Operations

Scans - SBOM

Operations

AI

Operations

Red Team

Operations