Container Registry API, REST: Scanner.List

Field

Description

imageId

string

The maximum string length in characters is 50.

Includes only one of the fields imageId, repositoryId.

ID of the Image or Repository to list ScanResults for.

To get the image ID use a yandex.cloud.containerregistry.v1.ImageService.List request.
To get the repository ID use a yandex.cloud.containerregistry.v1.RepositoryService.List request.

repositoryId

string

The maximum string length in characters is 50.

Includes only one of the fields imageId, repositoryId.

ID of the Image or Repository to list ScanResults for.

To get the image ID use a yandex.cloud.containerregistry.v1.ImageService.List request.
To get the repository ID use a yandex.cloud.containerregistry.v1.RepositoryService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListRegistriesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

Acceptable values are 0 to 1000, inclusive.

pageToken

string

Page token. To get the next page of results, set pageToken to the
ListRegistriesResponse.nextPageToken returned by a previous list request.

The maximum string length in characters is 100.

filter

string

A filter expression that filters resources listed in the response.
The expression must specify:

1. The field name. Currently you can use filtering only on ScanResult.status field.
2. An = operator.
3. The value in double quotes (").

The maximum string length in characters is 1000.

orderBy

string

An order expression that orders resources listed in the response.
The expression must specify:

1. The field name. Currently you can use filtering only on ScanResult.status field.
2. Order selector. Currently you can use ordering only on ScanResult.status field (critical first).

The maximum string length in characters is 100.

Field

Description

scanResults[]

ScanResult

List of ScanResult resources.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListImagesRequest.pageSize, use
the nextPageToken as the value
for the ListImagesRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Field

Description

id

string

Output only. ID of the ScanResult.

imageId

string

Output only. ID of the Image that the ScanResult belongs to.

scannedAt

string (date-time)

Output only. The timestamp in RFC3339 text format when the scan been finished.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

status

enum (Status)

Output only. The status of the ScanResult.

• RUNNING: Image scan is in progress.
• READY: Image has been scanned and result is ready.
• ERROR: Image scan is failed.

vulnerabilities

VulnerabilityStats

Output only. Summary information about vulnerabilities found.

Field

Description

critical

string (int64)

Count of CRITICAL vulnerabilities.

high

string (int64)

Count of HIGH vulnerabilities.

medium

string (int64)

Count of MEDIUM vulnerabilities.

low

string (int64)

Count of LOW vulnerabilities.

negligible

string (int64)

Count of NEGLIGIBLE vulnerabilities.

undefined

string (int64)

Count of other vulnerabilities.