Skip to content

Mend API (3.0.1)

Mend's enhanced SCA 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 App.
  • Improved security with a JWT token per organization, which expires every 30 minutes.
  • Added scalability with support for pagination, filtering and sorting search results.
  • 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
Languages
Servers
Generated server url

https://api-saas.mend.io/

Operations
Operations
Operations
Operations

project-attribution-report-controller

Operations
Operations
Operations
Operations

Request

Returns a product as identified by its token

Security
bearer-key
Path
productTokenstringrequired

product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: Integrate tab > Product Token).

No request payload

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
retValobject(ContextEntityDTO)
Response
application/json
{ "supportToken": "1171c60d", "retVal": { "uuid": "123e4567-e89b-12d3-a456-426655440000", "name": "Context A" } }

Request

Renames the product identified by its token

Security
bearer-key
Path
productTokenstringrequired

product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: Integrate tab > Product Token).

Bodyapplication/jsonrequired
namestring(Entity Name)required
Example: "Entity A"
application/json
{ "name": "Entity A" }

Responses

OK

Bodyapplication/json
supportTokenstring(Support Token)
Example: "1171c60d"
retValobject(ProductDTO)
Response
application/json
{ "supportToken": "1171c60d", "retVal": { "uuid": "123e4567-e89b-12d3-a456-426655440000", "name": "Product A" } }

Request

Deletes a product as identified by its token

Security
bearer-key
Path
productTokenstringrequired

product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: Integrate tab > Product Token).

No request payload

Responses

OK

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

Request

Returns a list of the projects and their tokens for a given product

Security
bearer-key
Path
productTokenstringrequired

product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: Integrate tab > Product Token).

Query
pageSizestring<= 10000
Default "50"
pagestring
Default "0"
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.
  • isLastPage: Defines whether the current page represents the conclusion of the API response. When “true”, this signifies you are viewing the last page of the API response. When “false”, this indicates there are further pages remaining.
Example: {"totalItems":"422","isLastPage":"true"}
supportTokenstring(Support Token)
Example: "1171c60d"
retValArray of objects(ProjectDTO)
Response
application/json
{ "additionalData": { "totalItems": "422", "isLastPage": "true" }, "supportToken": "1171c60d", "retVal": [ {} ] }

Request

Creates a new project within a given product. If the project already exists it returns the existing project.

Security
bearer-key
Path
productTokenstringrequired

product UUID (by running Entities - Organization > Get Organization Products) or Product Token (from the Mend SCA App: Integrate tab > Product Token).

Bodyapplication/jsonrequired
projectNamestring(Project Name)required
Example: "Project A"
projectDescriptionstring(Project Description)
Example: "Description for project"
application/json
{ "projectName": "Project A", "projectDescription": "Description for project" }

Responses

OK

Bodyapplication/json
additionalDataobject(Provides insights on creating resources using supported endpoints.)
  • created: Indicates whether the requested project was successfully created or if it already exists. When “true”, this signifies the project was successfully created. When “false”, this indicates the project already exists
Example: {"created":"true"}
supportTokenstring(Support Token)
Example: "1171c60d"
retValobject(ProjectDTO)
Response
application/json
{ "additionalData": { "created": "true" }, "supportToken": "1171c60d", "retVal": { "uuid": "123e4567-e89b-12d3-a456-426655440000", "name": "My Project", "path": "My Product", "productName": "My Product", "productUuid": "123e4567-e89b-12d3-a456-426655440000" } }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

User Management - Roles And Permissions

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

product-attribution-report-controller

Operations