Platform API 3.0

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

Export Code Project Suppressions report asynchronously

Request

Path

projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

additionalParamsobject

application/json

{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

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

Export Code Project Findings report asynchronously

Request

Path

projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

additionalParamsobject

application/json

{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

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

Export Code Project Compliance report asynchronously

Request

Path

projectUuidstringrequired

UUID of the project

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

complianceStandardstring

reportLevelstring

descriptionstring

additionalParamsobject

application/json

{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "complianceStandard": "string",
  "reportLevel": "string",
  "description": "string",
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

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

Export Code Organization Compliance report asynchronously

Request

Path

orgUuidstringrequired

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

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

complianceStandardstring

reportLevelstring

descriptionstring

additionalParamsobject

application/json

{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "complianceStandard": "string",
  "reportLevel": "string",
  "description": "string",
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

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

Export Code Application Suppressions report asynchronously

Request

Path

applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

additionalParamsobject

application/json

{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

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

Export Code Application Findings report asynchronously

Request

Path

applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

additionalParamsobject

application/json

{
  "name": "string",
  "format": "json",
  "sendEmailNotification": true,
  "additionalParams": {
    "property1": [ … ],
    "property2": [ … ]
  }
}

Responses

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

Export Code Application Compliance report asynchronously

Request

Path

applicationUuidstringrequired

Application UUID (Administration > Applications)

Bodyapplication/jsonrequired

namestring

formatstring

Enum"json""html""unknown""xml""excel""yaml""pdf""tv""rdf""csv"

sendEmailNotificationboolean

Mend API (3.0)

Access Management

Administration - Groups

Administration - Users

Administration - Labels

Reports

Export Code Project Suppressions report asynchronously

Request

Responses

Was this helpful?

Export Code Project Findings report asynchronously

Request

Responses

Was this helpful?

Export Code Project Compliance report asynchronously

Request

Responses

Was this helpful?

Export Code Organization Compliance report asynchronously

Request

Responses

Was this helpful?

Export Code Application Suppressions report asynchronously

Request

Responses

Was this helpful?

Export Code Application Findings report asynchronously

Request

Responses

Was this helpful?

Export Code Application Compliance report asynchronously

Request

Mend API (3.0)

Access Management

Administration - Groups

Administration - Users

Administration - Labels

Reports

Export Code Project Suppressions report asynchronously

RequestExpand all

Responses

Was this helpful?

Export Code Project Findings report asynchronously

RequestExpand all

Responses

Was this helpful?

Export Code Project Compliance report asynchronously

RequestExpand all

Responses

Was this helpful?

Export Code Organization Compliance report asynchronously

RequestExpand all

Responses

Was this helpful?

Export Code Application Suppressions report asynchronously

RequestExpand all

Responses

Was this helpful?

Export Code Application Findings report asynchronously

RequestExpand all

Responses

Was this helpful?

Export Code Application Compliance report asynchronously

RequestExpand all

Request

Request

Request

Request

Request

Request

Request