Contact UsGet started

Container Registry API, REST: Registry.List

Written by
Updated at October 17, 2024

Retrieves the list of Registry resources in the specified folder.

HTTP request

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

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to list registries in.

To get the folder ID use a yandex.cloud.resourcemanager.v1.FolderService.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.

pageToken

string

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

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 Registry.name field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].

Response

HTTP Code: 200 - OK

{
  "registries": [
    {
      "id": "string",
      "folderId": "string",
      "name": "string",
      "status": "string",
      "createdAt": "string",
      "labels": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

registries[]

Registry

List of Registry 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 ListRegistriesRequest.pageSize, use
the nextPageToken as the value
for the ListRegistriesRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

Registry

A Registry resource. For more information, see the Registry section of the documentation.

Field

Description

id

string

Output only. ID of the registry.

folderId

string

ID of the folder that the registry belongs to.

name

string

Name of the registry.

status

enum (Status)

Output only. Status of the registry.

  • STATUS_UNSPECIFIED
  • CREATING: Registry is being created.
  • ACTIVE: Registry is ready to use.
  • DELETING: Registry is being deleted.

createdAt

string (date-time)

Output only. Creation timestamp in RFC3339 text format.

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

labels

string

Resource labels as key:value pairs. Maximum of 64 per resource.
Previous
Get
Next
Create