Yandex Cloud Registry API, REST: Registry.List

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.

The maximum string length in characters is 50.

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: 10.

The maximum value is 1000.

pageToken

string

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

nameFilter

string

Filter by registry name.
The expression must specify:

1. The field name
2. An operator: =, !=.
3. The value in double quotes.
   Examples:
   name = "my-registry"
   name != "my-registry"
   No regular expressions allowed.

The maximum string length in characters is 1000.

kind[]

enum (Kind)

Match by registry kind (for example DOCKER, MAVEN, NPM).
Empty list means any kind.

• MAVEN: Registry kind is maven.
• NPM: Registry kind is npm.
• DOCKER: Registry kind is docker.
• DEBIAN: Registry kind is debian.
• NUGET: Registry kind is nuget.
• PYPI: Registry kind is pypi.
• BINARY: Regisrty kind is binary.
• GO: Registry kind is go.

type[]

enum (Type)

Match by registry type (for example LOCAL, REMOTE).
Empty list means any type.

• LOCAL: Registry type is local.
• REMOTE: Registry type is remote.
• VIRTUAL: Registry type is virtual.
• TRANSITIONAL: Registry type is transitional.

status[]

enum (Status)

Match by registry status. Empty list means any status.

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

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.

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.

description

string

Description of the registry.

kind

enum (Kind)

Kind of the registry.

• MAVEN: Registry kind is maven.
• NPM: Registry kind is npm.
• DOCKER: Registry kind is docker.
• DEBIAN: Registry kind is debian.
• NUGET: Registry kind is nuget.
• PYPI: Registry kind is pypi.
• BINARY: Regisrty kind is binary.
• GO: Registry kind is go.

type

enum (Type)

Type of the registry.

• LOCAL: Registry type is local.
• REMOTE: Registry type is remote.
• VIRTUAL: Registry type is virtual.
• TRANSITIONAL: Registry type is transitional.

status

enum (Status)

Output only. Status of the registry.

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

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

properties

object (map<string, string>)

Resource properties as key:value pairs. Maximum of 64 per resource.

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

modifiedAt

string (date-time)

Output only. Modification 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).

patternFilter

PatternFilter

Pattern filters for artifacts in the registry.

Field

Description

includePatterns[]

string

List of patterns for artifacts to include.

Each value must match the regular expression [A-Za-z0-9._~:@!$PATTERN+\-?*/]+.

excludePatterns[]

string

List of patterns for artifacts to exclude.

Each value must match the regular expression [A-Za-z0-9._~:@!$PATTERN+\-?*/]+.