Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

BareMetal API, REST: Image.Get

Written by
Updated at April 21, 2026
View in Markdown

Returns the specific Image resource.
To get the list of available Image resources, make a List request.

HTTP request

GET https://baremetal.api.cloud.yandex.net/baremetal/v1alpha/images/{imageId}

Path parameters

Field

Description

imageId

string

Required field. ID of the Image resource to return.
To get the image ID, use a ImageService.List request.

Value must match the regular expression [a-z][a-z0-9]*.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "name": "string",
  "description": "string",
  "checksum": "string",
  "status": "string",
  "createdAt": "string",
  "labels": "object"
}

An Image resource.

Field

Description

id

string

ID of the image.

folderId

string

ID of the folder that the image belongs to.

name

string

Name of the image.
The name is unique within the folder.

description

string

Description of the image.

checksum

string

MD5 checksum of the image.

status

enum (Status)

Status of the image.

  • CREATING: Image is being created.
  • READY: Image is ready to use.
  • ERROR: Image encountered an error.
  • DELETING: Image is being deleted.
  • UPDATING: Image is being updated.

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

labels

object (map<string, string>)

Resource labels as key:value pairs.
Previous
Overview
Next
List