Skip to content
Platform API 3.0
/
/
Export account inventory...

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

Export Images Project Due Diligence report asynchronously (Containers)

Request

Security
bearer-key
Path
projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
uuidstring
namestring
scopeUuidstring
scopeNamestring
subScopesArray of objects(EntityTreeDTO)
titlestring
reportTypestring
Enum"attribution""inventory""vulnerabilities""securityAlerts""sbom""securityAlertsLibrary""Compliance""Findings""Suppressions""Resolved"
formatstring
Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"
scopeTypestring
Enum"organization""product""project""unsupported""account"
scopeUuidListArray of strings
projectUuidsArray of strings
statusstring
Enum"PENDING""IN_PROGRESS""FAILED""FAILURE""SUCCESS"
createdBystring
createdAtstring(date-time)
sendEmailNotificationboolean
labelsUuidListArray of strings
includeVulnerabilitiesboolean
excludeInactiveProjectsboolean
application/json
{
  "uuid": "string",
  "name": "string",
  "scopeUuid": "string",
  "scopeName": "string",
  "subScopes": [
    { … }
  ],
  "title": "string",
  "reportType": "attribution",
  "format": "json",
  "scopeType": "organization",
  "scopeUuidList": [
    "string"
  ],
  "projectUuids": [
    "string"
  ],
  "status": "PENDING",
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "sendEmailNotification": true,
  "labelsUuidList": [
    "string"
  ],
  "includeVulnerabilities": true,
  "excludeInactiveProjects": true
}

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": [ … ],
    "includeVulnerabilities": true,
    "excludeInactiveProjects": true
  }
}

Export account inventory report asynchronously (Dependencies - SCA)

Request

Security
bearer-key
Path
accountUuidstringrequired

Account UUID

Bodyapplication/jsonrequired
namestring
sendEmailNotificationboolean
formatstring
Value"excel"
searchstring(Search Query)

Filter your search to return items whose property has a specific value. Use the syntax: [property][operator][value]

  • Property: the name of the property of the item
  • Operator:
    • equals (==) - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator). Example: entity==abc* — will return true for entities like "abcd" and "abc_123".
  • Value: the value of the property.

Logical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)

This endpoint supports filtering on the following properties and its supported operators:

  • libraryName: equals
Example: "libraryName==*log4j*"
application/json
{
  "name": "string",
  "sendEmailNotification": true,
  "format": "excel",
  "search": "libraryName==*log4j*"
}

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

Export account Dependency Security Findings report asynchronously (Dependencies - SCA)

Request

Security
bearer-key
Path
accountUuidstringrequired

Account UUID

Bodyapplication/jsonrequired
namestring
sendEmailNotificationboolean
formatstring
Value"excel"
searchstring(Search Query)

Filter your search to return items whose property has a specific value. Use the syntax: [property][operator][value]

  • Property: the name of the property of the item
  • Operator:
    • equals (==) - Returns true if the value exactly matches this one. If the value contains a * character, it behaves like a wildcard (similar to the LIKE operator). Example: entity==abc* — will return true for entities like "abcd" and "abc_123".
  • Value: the value of the property.

Logical operators AND (;) and OR (,) are supported in filters — param1=in=(val1,val2) and (param2==val3 or param3==val4), can also be written as — param1=in=(val1,val2);(param2==val3,param3==val4)

This endpoint supports filtering on the following properties and its supported operators:

  • findingId: equals
Example: "findingId==CVE-2020-8908"
application/json
{
  "name": "string",
  "sendEmailNotification": true,
  "format": "excel",
  "search": "findingId==CVE-2020-8908"
}

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

Scans

Operations

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations

Integrations

Operations

Dependencies Source Files

Operations

AI

Operations

Red Team

Operations