Platform API 3.0
/
Projects

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

Scans

Operations

Projects

Operations

Get Project Labels

Request

Get project labels. A label can be a string or namespace:value pair that provide additional metadata to assist with project management.

Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseArray of objects(EntityLabelDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": [
    { … }
  ]
}

Add Project Label

Request

Adds a new label to a project. A label can be a string or namespace:value pair that provide additional metadata to assist with project management.

Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired
entityUuidsArray of strings(Entity Uuid)required
Example: ["123e4567-e89b-12d3-a456-426655440000"]
namespacestring(Label Namespace)required
Example: "Label Namespace A"
valuestring(Label Value)required
Example: "Label Value A"
application/json
{
  "entityUuids": [
    "123e4567-e89b-12d3-a456-426655440000"
  ],
  "namespace": "Label Namespace A",
  "value": "Label Value A"
}

Responses

OK

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

Get Project Statistics

Request

Returns the requested statistics for the given projects

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"
Bodyapplication/jsonrequired
projectUuidsArray of strings(Project Identifiers)
Example: ["123e4567-e89b-12d3-a456-426655440000"]
applicationUuidArray of strings(Application Identifiers)
Example: ["123e4567-e89b-12d3-a456-426655440000"]
application/json
{
  "projectUuids": [
    "123e4567-e89b-12d3-a456-426655440000"
  ],
  "applicationUuid": [
    "123e4567-e89b-12d3-a456-426655440000"
  ]
}

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

Get Project Violating Findings

Request

Returns the violations relates to project

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

Get Organization Projects

Request

Returns a list of all projects accessible to the current user

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

Remove Project Label

Request

Removes a label from a project

Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

labelUuidstringrequired

Label UUID (Administration > Labels)

No request payload

Responses

OK

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

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations