Platform API 3.0
/
Scans
/
Get Scan Summary

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

Get Scan Tags

Request

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": [
    { … }
  ]
}

Add Scan Tag

Request

Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

Bodyapplication/jsonrequired
keystring(Tag Key)required
Example: "Tag Key A"
valuestring(Tag Value)required
Example: "Tag Value A"
application/json
{
  "key": "Tag Key A",
  "value": "Tag Value A"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ScanTagDTO)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "key": "commit",
    "value": "123abc",
    "displayName": "commit:123abc",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

Get Scan

Request

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": "SCA",
    "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"
  }
}

Update Scan

Request

Path
orgUuidstringrequired

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

projectUuidstringrequired

UUID of the project

scanUuidstringrequired

Scan UUID

Bodyapplication/jsonrequired
statusstring
Enum"PLACE_HOLDER_01""PLACE_HOLDER_02""PLACE_HOLDER_03""RUNNING""PLACE_HOLDER_04""PLACE_HOLDER_05""PLACE_HOLDER_06""PARTIAL""PROCESSING""PLACE_HOLDER_07"
application/json
{
  "status": "PLACE_HOLDER_01"
}

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
responseobject(ScanDTOV3)
Response
application/json
{
  "supportToken": "1171c60d",
  "response": {
    "uuid": "string",
    "name": "string",
    "engine": "SCA",
    "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"
  }
}

Get Scan Statistics

Request

Returns the requested statistics for the given scans

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

Get Scan Summary

Request

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": "string",
    "scanDuration": "string",
    "projectName": "string",
    "projectUuid": "string",
    "tags": [ … ],
    "path": "string",
    "applicationUuid": "string",
    "statistics": { … }
  }
}

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations