Yandex Cloud Registry API, REST: Artifact.List
Returns a list of artifacts.
HTTP request
GET https://registry.api.cloud.yandex.net/cloud-registry/v1/artifacts
Query parameters
|
Field |
Description |
|
folderId |
string ID of the folder to list artifacts in. The maximum string length in characters is 50. |
|
registryId |
string ID of the registry to list artifacts in. The maximum string length in characters is 50. |
|
registryKind[] |
enum (Kind) Match by registry kind (for example DOCKER, MAVEN, NPM).
|
|
registryType[] |
enum (Type) Match by registry type (for example LOCAL, REMOTE). Supported kinds: LOCAL, REMOTE
|
|
pageSize |
string (int64) Page size. Acceptable values are 0 to 1000, inclusive. |
|
pageToken |
string Page token from the previous response. Empty for the first page. |
|
nameFilter |
string Filter by artifact name.
The maximum string length in characters is 1000. |
|
pathFilter |
string Filter by artifact path.
The maximum string length in characters is 1000. |
|
status[] |
enum (Status) Match by artifact status. Empty list means any status.
|
|
kind[] |
enum (Kind) Match by artifact kind. Empty list means any kind (both FOLDER and ARTIFACT).
|
|
labels[] |
string Match by labels. All listed labels must match (AND). |
|
createdAfter |
string (date-time) Return items created at this time or later. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdBefore |
string (date-time) Return items created before this time. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
orderBy |
string Sort order. Comma-separated "field [asc|desc]", e.g. "name desc". The maximum string length in characters is 256. |
Response
HTTP Code: 200 - OK
{
"artifacts": [
{
"id": "string",
"path": "string",
"name": "string",
"kind": "string",
"status": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"modifiedBy": "string",
"properties": "object",
"content": {
// Includes only one of the fields `docker`
"docker": {
// Includes only one of the fields `imageManifest`, `manifestList`
"imageManifest": {
"config": {
"digest": "string",
"size": "string"
},
"layers": [
{
"digest": "string",
"size": "string"
}
]
},
"manifestList": {
"manifests": [
{
"manifestDescriptor": {
"digest": "string",
"size": "string"
},
"platform": {
"architecture": "string",
"os": "string",
"osVersion": "string",
"variant": "string"
}
}
]
},
// end of the list of possible fields
"manifestDigest": "string"
}
// end of the list of possible fields
},
"registryId": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
artifacts[] |
List of artifacts that match the request. |
|
nextPageToken |
string Token to get the next page of results. |
Artifact
A Artifact resource.
|
Field |
Description |
|
id |
string Output only. ID of the artifact. |
|
path |
string Path where the artifact is located. |
|
name |
string Name of the artifact. |
|
kind |
enum (Kind) Kind of the artifact.
|
|
status |
enum (Status) Output only. Status of the artifact.
|
|
createdAt |
string (date-time) Output only. Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
createdBy |
string Output only. ID of the user or service account who created the artifact. |
|
modifiedAt |
string (date-time) Output only. Modification timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
modifiedBy |
string Output only. ID of the user or service account who last modified the artifact. |
|
properties |
object (map<string, string>) Key-value properties associated with the artifact. |
|
content |
Content of the artifact. |
|
registryId |
string Output only. ID of the registry that contains this artifact. |
Content
Content of the artifact, specific to its type.
|
Field |
Description |
|
docker |
Docker-specific content. Includes only one of the fields |
DockerContent
Docker-specific content of the artifact.
|
Field |
Description |
|
imageManifest |
Single-platform image manifest. Includes only one of the fields |
|
manifestList |
Multi-platform manifest list. Includes only one of the fields |
|
manifestDigest |
string Digest of the manifest. |
ImageManifest
Image manifest describing a single-platform Docker image.
|
Field |
Description |
|
config |
Descriptor of the image configuration. |
|
layers[] |
Descriptors of the image layers. |
Descriptor
Descriptor of a content blob (config, layer, or manifest).
|
Field |
Description |
|
digest |
string Digest of the content. |
|
size |
string (int64) Size of the content in bytes. |
ManifestList
Manifest list describing a multi-platform Docker image.
|
Field |
Description |
|
manifests[] |
List of platform-specific manifests. |
PlatformManifest
Platform-specific manifest entry within a manifest list.
|
Field |
Description |
|
manifestDescriptor |
Descriptor of the platform-specific manifest. |
|
platform |
Platform this manifest targets. |
Platform
Platform describes the target OS and architecture of an image.
|
Field |
Description |
|
architecture |
string CPU architecture. |
|
os |
string Operating system. |
|
osVersion |
string OS version. |
|
variant |
string CPU variant. |