Legacy Container Image API

/

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

Overview

License Apache 2.0

Servers

https://baseUrl/cn/api/v2.0/

http://baseUrl/cn/api/v2.0/

Kubernetes

Operations

Compliance

Operations

Images

Operations

Get Images

Request

Get the image of the project

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

Query

sortstring

sorted by, default is lastScanDate

Default "lastScanDate"

orderstring

order sorting, possible values are asc/desc

Default "desc"

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

registriesstring

one or more image registries names separated by commas

repositoriesstring

one or more image repositories names separated by commas

tagsstring

image tags

imageSourcestring

image source

maxRiskScorestring

image max risk score

lastScanDatestring

image last scan date

isViolatedboolean

is violated policies

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 Image vulnerabilities

Request

Get the image vulnerabilities

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

onlyOsboolean

is only OS packages

withFixboolean

has fix

severitystring

vendor severity filter

excludeBaseLayersboolean

exclude vulnerabilities from base Layers

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 image layers

Request

Get the image layers

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

layeruuidstringrequired

layer UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

excludeBaseLayersboolean

exclude base Layers

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 image packages

Request

Get the image packages

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

onlyOsboolean

is only OS packages

excludeBaseLayersboolean

exclude packages from base Layers

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 image secrets

Request

Get the image secrets

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

severitystring

vendor severity filter

excludeBaseLayersboolean

exclude secrets from base Layers

No request payload

Responses

Data field refers to a list of objects

Body*/*

additionalInfoobject(common.Pagination)

dataany

Get image

Request

Get a specific image

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

scanuuidstringrequired

scan 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 image/project/application deployment data

Request

Get image/project/application deployment data

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

applicationuuidstringrequired

application UUID

scanuuidstringrequired

scan UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

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 image layers

Request

Get the image layers

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

scanuuidstringrequired

scan UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

excludeBaseLayersboolean

exclude base Layers

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 image layers findings

Request

Get the specific image layer vulnerabilities

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

scanuuidstringrequired

scan UUID

layeruuidstringrequired

layer UUID

Query

onlyOsboolean

is only OS packages

withFixboolean

has fix

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 image layer secrets

Request

Get the specific image layer secrets

Path

orguuidstringrequired

organization UUID

scanuuidstringrequired

scan UUID

layeruuidstringrequired

layer UUID

Query

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

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 image packages

Request

Get the image packages

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

scanuuidstringrequired

scan UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

onlyOsboolean

is only OS packages

excludeBaseLayersboolean

exclude packages from base Layers

reachabilityStatusesArray of strings

reachability statuses

minReachabilityConfidencenumber

min reachability confidence

maxReachabilityConfidencenumber

max reachability confidence

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 reachability info for a specific package

Request

Get reachability info for a specific package

Path

orguuidstringrequired

organization uuid

scanuuidstringrequired

scan UUID

pkguuidstringrequired

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 image secrets

Request

Get the image secrets

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

scanuuidstringrequired

scan UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

severitystring

vendor severity filter

excludeBaseLayersboolean

exclude secrets from base Layers

No request payload

Responses

Data field refers to a list of objects

Body*/*

additionalInfoobject(common.Pagination)

dataany

Get Scan vulnerabilities

Request

Get the scan vulnerabilities

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

scanuuidstringrequired

scan UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

onlyOsboolean

is only OS packages

withFixboolean

has fix

severitystring

vendor severity filter

excludeBaseLayersboolean

exclude vulnerabilities from base Layers

reachabilityStatusesArray of strings

reachability statuses

minReachabilityConfidencenumber

min reachability confidence

maxReachabilityConfidencenumber

max reachability confidence

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 vulnerabilities

Request

Get the package vulnerabilities

Path

orguuidstringrequired

organization UUID

projectuuidstringrequired

project UUID

packageuuidstringrequired

package UUID

Query

sortstring

sort by

orderstring

order sorting, possible values are asc/desc

pageinteger

page number

Default 1

sizeinteger

number of objects per page

Default 1000

severitystring

vendor severity filter

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
}

Registry

Operations

Runtime

Operations