SCA API 2.0
/
Entities - Organization

Mend API (2.0)

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
2.0.json
2.0.yaml
Languages
Servers
Generated server url
https://api-saas.mend.io/

Entities - Project

Operations

Policies - Project

Operations

Alerts - Project

Operations

project-attribution-report-controller

Operations

application-violations-controller

Operations

Policies - Product

Operations

Entities - Product

Operations

Settings - Whitelist

Operations

Settings - In-House

Operations

Policies - Organization

Operations

User Management - Groups

Operations

Entities - Organization

Operations

Get Organization

Request

Returns an organization as identified by its token.

Path
orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

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

Rename Organization

Request

Renames the organization identified by its token

Path
orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

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

Responses

OK

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

Get Organization Projects

Request

Returns a list of all projects accessible to the current user

Path
orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

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

Create Project With A New Product

Request

Creates a new project within a new product. If project name exists will return existing project

Path
orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

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

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(CreateProjectResponseDTO)
Response
application/json
{
  "additionalData": {
    "created": "true"
  },
  "supportToken": "1171c60d",
  "retVal": {
    "project": { … },
    "product": { … }
  }
}

Get Organization Products

Request

Returns a list of all products accessible to the current user

Path
orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

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(ProductDTO)
Response
application/json
{
  "additionalData": {
    "totalItems": "422",
    "isLastPage": "true"
  },
  "supportToken": "1171c60d",
  "retVal": [
    { … }
  ]
}

Create Product

Request

Creates a new product, If the product already exists it returns the existing product

Path
orgTokenstringrequired

org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: Integrate tab > API Key).

Bodyapplication/jsonrequired
productNamestring(Product Name)required
Example: "Product A"
application/json
{
  "productName": "Product A"
}

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(ProductDTO)
Response
application/json
{
  "additionalData": {
    "created": "true"
  },
  "supportToken": "1171c60d",
  "retVal": {
    "uuid": "123e4567-e89b-12d3-a456-426655440000",
    "name": "Product A"
  }
}

Get User Organizations

Request

Returns a list of all organizations where the current user is a member.

No request payload

Responses

OK

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

Create Organization