Legacy Container Image API
/
Compliance

Mend Container Image API (2.0)

Mend's enhanced Container Image API enables automation of workflows. The API features:

  • Access for any user with Mend credentials, via a user key available in the user's profile page in the Mend Application.
  • 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. To access your base URL for API calls go to the Mend Application > Cloud Native.

Download OpenAPI description
2.0.json
2.0.yaml
Overview
License Apache 2.0
Languages
Servers
https://baseUrl/cn/api/v2.0/
http://baseUrl/cn/api/v2.0/

Kubernetes

Operations

Compliance

Operations

Get Package Copyrights

Request

Get the package copyrights

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Query
sortstring

sort by

orderstring

order sorting, possible values are asc/desc

No request payload

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Update Package Copyrights

Request

Update package copyrights

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Bodyapplication/jsonrequired

copyrights to update

Array [
copyrightAssignedBystring
copyrightAuthorstring
copyrightCommentstring
copyrightEndYearstring
copyrightOrganizationstring
copyrightStartYearstring
copyrightURLstring
orgUUIDstring
packageUUIDstring
]
application/json
[
  {
    "copyrightAssignedBy": "string",
    "copyrightAuthor": "string",
    "copyrightComment": "string",
    "copyrightEndYear": "string",
    "copyrightOrganization": "string",
    "copyrightStartYear": "string",
    "copyrightURL": "string",
    "orgUUID": "string",
    "packageUUID": "string"
  }
]

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Delete Package Copyrights

Request

Delete package copyrights

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Bodyapplication/jsonrequired

licenses names to delete

findingsToDeleteobject(inputs.ComplianceFindingToDelete)
orgUUIDstring
packageUUIDstring
application/json
{
  "findingsToDelete": {
    "copyrights": [ … ],
    "licenses": [ … ]
  },
  "orgUUID": "string",
  "packageUUID": "string"
}

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Revert Package Copyrights

Request

Revert package copyrights

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

No request payload

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Get Package Info

Request

Get the package info

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Query
sortstring

sort by

orderstring

order sorting, possible values are asc/desc

No request payload

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Update Package Info

Request

Update package info

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Bodyapplication/jsonrequired

info to update

Array [
descriptionstring
isCompliantboolean
noticestring
orgUUIDstring
packageUUIDstring
]
application/json
[
  {
    "description": "string",
    "isCompliant": true,
    "notice": "string",
    "orgUUID": "string",
    "packageUUID": "string"
  }
]

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Get Package Licenses

Request

Get the pacakge licenses

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Query
sortstring

sort by

orderstring

order sorting, possible values are asc/desc

No request payload

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Update Package Licenses

Request

Update package licenses

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Bodyapplication/jsonrequired

licenses to update

Array [
licenseAssignedBystring
licenseCommentstring
licenseIsCompliantboolean
licenseNamestring
licenseRiskScoreinteger
licenseSeveritystring
licenseURLstring
orgUUIDstring
packageUUIDstring
]
application/json
[
  {
    "licenseAssignedBy": "string",
    "licenseComment": "string",
    "licenseIsCompliant": true,
    "licenseName": "string",
    "licenseRiskScore": 0,
    "licenseSeverity": "string",
    "licenseURL": "string",
    "orgUUID": "string",
    "packageUUID": "string"
  }
]

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Delete Package Licenses

Request

Delete package licenses

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

Bodyapplication/jsonrequired

licenses names to delete

findingsToDeleteobject(inputs.ComplianceFindingToDelete)
orgUUIDstring
packageUUIDstring
application/json
{
  "findingsToDelete": {
    "copyrights": [ … ],
    "licenses": [ … ]
  },
  "orgUUID": "string",
  "packageUUID": "string"
}

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Revert Package Licenses

Request

Revert package licenses

Path
orguuidstringrequired

organization UUID

packageuuidstringrequired

package UUID

No request payload

Responses

Data field refers to a list of objects

Bodyapplication/json
additionalInfoobject(common.Pagination)
dataany
Response
application/json
{
  "additionalInfo": {
    "isLastPage": true,
    "page": 0,
    "pageCount": 0,
    "pageSize": 20,
    "size": 20,
    "totalCount": 0,
    "totalItems": 0
  },
  "data": null
}

Images

Operations

Registry

Operations

Runtime

Operations