Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
© 2022 Yandex.Cloud LLC
Yandex Container Registry
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Authentication in Container Registry
    • Managing a Docker image
      • Getting information about available Docker images
      • Creating a Docker image
      • Pushing a Docker image to a registry
      • Pulling a Docker image from a registry
      • Deleting a Docker image from a registry
    • Managing Helm charts
      • Getting information about available Helm charts
      • Pushing a Helm chart to a registry
      • Pulling a Helm chart from a registry
      • Deleting a Helm chart from a registry
    • Managing a registry
      • Getting information about existing registries
      • Creating a registry
      • Updating a registry
      • Deleting a registry
    • Managing a repository
      • Getting information about existing repositories
      • Creating a repository
    • Managing Docker image lifecycle policies
      • Getting information about existing lifecycle policies
      • Creating a lifecycle policy
      • Updating a lifecycle policy
      • Performing lifecycle policy dry runs
      • Deleting a lifecycle policy
    • Scanning Docker images for vulnerabilities
    • Working with roles
      • Assigning a role
      • Viewing assigned roles
      • Revoking a role
  • Yandex Container Solution
  • Practical guidelines
    • All tutorials
    • Running a Docker image on a VM
    • Creating a trigger with Yandex Cloud Functions
    • Setting up automatic scanning of a Docker image
  • Concepts
    • Overview
    • Docker image
    • Docker volume
    • Registry
    • Repository
    • Docker image lifecycle policies
    • Vulnerability scanner
    • Yandex Cloud Functions trigger
    • Backups
    • Quotas and limits
  • Access management
  • Pricing policy
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • ImageService
      • LifecyclePolicyService
      • RegistryService
      • RepositoryService
      • ScannerService
      • OperationService
    • REST
      • Overview
      • Image
        • Overview
        • delete
        • get
        • list
      • LifecyclePolicy
        • Overview
        • create
        • delete
        • dryRun
        • get
        • getDryRunResult
        • list
        • listDryRunResultAffectedImages
        • listDryRunResults
        • update
      • Registry
        • Overview
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listIpPermission
        • setAccessBindings
        • setIpPermission
        • update
        • updateAccessBindings
        • updateIpPermission
      • Repository
        • Overview
        • delete
        • get
        • getByName
        • list
        • listAccessBindings
        • setAccessBindings
        • updateAccessBindings
        • upsert
      • Scanner
        • Overview
        • get
        • getLast
        • list
        • listVulnerabilities
        • scan
  • Troubleshooting
  • Questions and answers
  1. API reference
  2. REST
  3. Image
  4. list

Method list

Written by
Yandex Cloud
  • HTTP request
  • Query parameters
  • Response

Retrieves the list of Image resources in the specified registry or repository.

HTTP request

GET https://container-registry.api.cloud.yandex.net/container-registry/v1/images

Query parameters

Parameter Description
registryId

ID of the registry to list Docker images in.

registryId is ignored if a repositoryName is specified in the request.

To get the registry ID use a list request.

The maximum string length in characters is 50.

repositoryName

Name of the repository to list Docker images in.

To get the repository name use a list request.

Value must match the regular expression |[a-z0-9]+(?:[._-][a-z0-9]+)*(/([a-z0-9]+(?:[._-][a-z0-9]+)*))*.

folderId

ID of the folder to list Docker images in.

folderId is ignored if a repositoryName or a registryId are specified in the request.

To get the folder ID use a list request.

The maximum string length in characters is 50.

pageSize

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

The maximum value is 1000.

pageToken

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

The maximum string length in characters is 100.

filter

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 Image.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be a maximum of 256 characters long and match the regular expression [a-z0-9]+(?:[._-][a-z0-9]+)*(/([a-z0-9]+(?:[._-][a-z0-9]+)*)).

The maximum string length in characters is 1000.

orderBy

The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "images": [
    {
      "id": "string",
      "name": "string",
      "digest": "string",
      "compressedSize": "string",
      "config": {
        "id": "string",
        "digest": "string",
        "size": "string",
        "urls": [
          "string"
        ]
      },
      "layers": [
        {
          "id": "string",
          "digest": "string",
          "size": "string",
          "urls": [
            "string"
          ]
        }
      ],
      "tags": [
        "string"
      ],
      "createdAt": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
images[] object

List of Image resources.

images[].
id
string

Output only. ID of the Docker image.

images[].
name
string

Name of the Docker image. The name is unique within the registry.

images[].
digest
string

Content-addressable identifier of the Docker image.

images[].
compressedSize
string (int64)

Compressed size of the Docker image, specified in bytes.

images[].
config
object

Configuration of the Docker image.

A Blob resource.

images[].
config.
id
string

Output only. ID of the blob.

images[].
config.
digest
string

Content-addressable identifier of the blob.

images[].
config.
size
string (int64)

Size of the blob, specified in bytes.

images[].
config.
urls[]
string

List of blob urls.

images[].
layers[]
object

Layers of the Docker image.

images[].
layers[].
id
string

Output only. ID of the blob.

images[].
layers[].
digest
string

Content-addressable identifier of the blob.

images[].
layers[].
size
string (int64)

Size of the blob, specified in bytes.

images[].
layers[].
urls[]
string

List of blob urls.

images[].
tags[]
string

Tags of the Docker image.

Each tag is unique within the repository.

images[].
createdAt
string (date-time)

Output only. Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

nextPageToken string

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

Was the article helpful?

Language / Region
© 2022 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Query parameters
  • Response