Contact UsGet started

BareMetal API, gRPC: ImageService.Get

Written by
Updated at March 28, 2025

Returns the specific Image resource.

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

gRPC request

rpc Get (GetImageRequest) returns (Image)

GetImageRequest

{
  "image_id": "string"
}

Field

Description

image_id

string

ID of the Image resource to return.

To get the image ID, use a ImageService.List request.

Image

{
  "id": "string",
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "checksum": "string",
  "status": "Status",
  "created_at": "google.protobuf.Timestamp",
  "labels": "map<string, string>"
}

An Image resource.

Field

Description

id

string

ID of the image.

folder_id

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.

  • STATUS_UNSPECIFIED: Unspecified image status.
  • 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

labels

object (map<string, string>)

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