Platform API 3.0

Get Project Scans

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

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

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

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

Security

bearer-key

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

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

Add Scan Tag

Request

Security

bearer-key

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

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

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

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

Update 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

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

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

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

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

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

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

Projects

Operations

Applications

Operations

Findings - Project

Operations

Findings - Scan

Operations

Integrations

Operations

Mend API (3.0)

Access Management

Administration - Groups

Administration - Users

Administration - Labels

Reports

Scans

Get Scan Tags

Request

Responses

Was this helpful?

Add Scan Tag

Request

Responses

Was this helpful?

Add Scan Tag

Request

Responses

Was this helpful?

Get Scan

Request

Responses

Was this helpful?

Update Scan

Request

Responses

Was this helpful?

Get Scan Summary

Request

Responses

Was this helpful?

Get Project Scans

Request

Responses

Was this helpful?

Projects

Applications

Findings - Project

Findings - Scan

Integrations