Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud Desktop
  • Access management
  • Pricing policy
    • API authentication
      • Overview
        • Overview
        • List
        • Get
        • Copy
        • Update
        • CopyFromDesktop
        • Delete
  • Cloud Desktop events
  • Release notes

In this article:

  • HTTP request
  • Path parameters
  • Response
  1. API reference
  2. REST
  3. DesktopImage
  4. Get

Cloud Desktop API, REST: DesktopImage.Get

Written by
Yandex Cloud
Updated at August 8, 2025
  • HTTP request
  • Path parameters
  • Response

Returns the specified desktop image.

HTTP requestHTTP request

GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/images/{imageId}

Path parametersPath parameters

Field

Description

imageId

string

Required field. ID of the image to get.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "status": "string",
  "name": "string",
  "labels": "object",
  "storageSize": "string",
  "minDiskSize": "string"
}

A desktop image resource.

Field

Description

id

string

ID of the image.

folderId

string

ID of the folder that the image belongs to.

createdAt

string (date-time)

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

status

enum (Status)

Status of the image.

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

name

string

Name of the image.

labels

object (map<string, string>)

Description of the image.

storageSize

string (int64)

Size of the image, specified in bytes.

minDiskSize

string (int64)

Minimum disk size in bytes required to use the image.

Was the article helpful?

Previous
List
Next
Copy
© 2025 Direct Cursus Technology L.L.C.