Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Container Registry
  • Getting started
  • Yandex Container Solution
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Scan
        • Get
        • GetLast
        • List
        • ListVulnerabilities
  • Monitoring metrics
  • Audit Trails events
  • Troubleshooting
  • FAQ

In this article:

  • HTTP request
  • Body parameters
  • Response
  • ScanMetadata
  • Status
  • ScanResult
  • VulnerabilityStats
  1. API reference
  2. REST
  3. Scanner
  4. Scan

Container Registry API, REST: Scanner.Scan

Written by
Yandex Cloud
Updated at November 26, 2024
  • HTTP request
  • Body parameters
  • Response
  • ScanMetadata
  • Status
  • ScanResult
  • VulnerabilityStats

Executes scanning of specified image.

HTTP requestHTTP request

POST https://container-registry.api.cloud.yandex.net/container-registry/v1/scans

Body parametersBody parameters

{
  "imageId": "string"
}

Field

Description

imageId

string

Required field. ID of the Image to be scanned for vulnerabilities.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "scanResultId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "imageId": "string",
    "scannedAt": "string",
    "status": "string",
    "vulnerabilities": {
      "critical": "string",
      "high": "string",
      "medium": "string",
      "low": "string",
      "negligible": "string",
      "undefined": "string"
    }
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

ScanMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

ScanResult

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

ScanMetadataScanMetadata

Field

Description

scanResultId

string

ID of the ScanResult that is being created.

StatusStatus

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ScanResultScanResult

A ScanResult resource.

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.

  • STATUS_UNSPECIFIED
  • 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.

VulnerabilityStatsVulnerabilityStats

A VulnerabilityStats resource.

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.

Was the article helpful?

Previous
Overview
Next
Get
© 2025 Direct Cursus Technology L.L.C.