List running images

GET

/v1/kubernetes/images

const url = 'https://api.devsecure.io/v1/kubernetes/images?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.devsecure.io/v1/kubernetes/images?limit=50' \
  --header 'Authorization: Bearer <token>'

One entry per cluster and image digest, with the workloads running it and CVE counts.

Authorizations

ApiKey
kubernetes:read
OAuth2
kubernetes:read

Parameters

Query Parameters

limit

Limit

Page size (1-200).

integer

default: 50 >= 1 <= 200

Page size (1-200).

cursor

Any of:

string
null

string

<= 1024 characters

Opaque cursor from the previous page.

cluster_id

Any of:

string
null

string

<= 64 characters

Responses

200

OK.

application/json

ImageList

object

data

required

Data

Array<object>

Image

object

cluster_id

required

Cluster Id

string format: uuid

digest

required

Digest

string

repository

Any of:

string
null

string

tag

Any of:

string
null

string

sbom_present

required

Sbom Present

boolean

workload_count

required

Workload Count

integer

workloads

required

Workloads

Up to 50 workloads running this image.

Array<object>

ImageWorkload

object

namespace

required

Namespace

string

kind

required

Kind

string

name

required

Name

string

container

required

Container

string

vulnerabilities

required

VulnerabilityCounts

object

critical

Critical

integer

high

High

integer

medium

Medium

integer

low

Low

integer

total

Total

Unique CVEs, each counted once.

integer

matched_at

Any of:

string
null

string

pagination

required

PageInfo

object

next_cursor

required

Any of:

string
null

string

has_more

required

Has More

boolean

Example

{
  "data": [
    {
      "vulnerabilities": {
        "critical": 0,
        "high": 0,
        "medium": 0,
        "low": 0,
        "total": 0
      }
    }
  ]
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

X-RateLimit-Limit

integer

Requests allowed per window.

X-RateLimit-Remaining

integer

Requests left in the window.

X-RateLimit-Reset

integer

Seconds until the window resets.

X-Has-Next-Page

string

Allowed values: true false

Whether another page follows.

400

The request is not valid (validation_error, invalid_cursor).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "The request is not valid.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

401

Missing, unknown, expired or revoked credential (invalid_credentials).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "invalid_credentials",
    "message": "The credential is missing, invalid, expired or revoked.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

403

The credential may not do this (insufficient_scope, permission_denied, plan_not_allowed, quota_exceeded, target_not_authorized).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "insufficient_scope",
    "message": "The credential does not have the scope this operation needs.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

429

Too many requests (rate_limited).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the time in Retry-After.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

X-RateLimit-Limit

integer

Requests allowed per window.

X-RateLimit-Remaining

integer

Requests left in the window.

X-RateLimit-Reset

integer

Seconds until the window resets.

Retry-After

integer

Seconds to wait before retrying.

500

Unexpected error (internal_error). Quote the request id to support.

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.