Contact UsGet started

Cloud Desktop API, REST: Desktop.Get

Written by
Updated at April 24, 2025

Returns the specified desktop resource.

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

HTTP request

GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktops/{desktopId}

Path parameters

Field

Description

desktopId

string

Required field. ID of the desktop resource to return.

To get the desktop ID use a DesktopService.List request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "desktopGroupId": "string",
  "createdAt": "string",
  "status": "string",
  "name": "string",
  "resources": {
    "memory": "string",
    "cores": "string",
    "coreFraction": "string"
  },
  "networkInterfaces": [
    {
      "networkId": "string",
      "subnetId": "string"
    }
  ],
  "users": [
    {
      "subjectId": "string",
      "subjectType": "string"
    }
  ],
  "labels": "object"
}

A desktop resource.

Field

Description

id

string

Desktop ID.

folderId

string

ID of the folder that the desktop belongs to.

desktopGroupId

string

ID of the desktop group that the desktop 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 desktop.

  • STATUS_UNSPECIFIED
  • CREATING: Desktop is being created.
  • ACTIVE: Desktop is ready to be used.
  • DELETING: Desktop is being deleted.
  • RESTARTING: Desktop is restarting.
  • UPDATING: Desktop is updating.
  • STARTING: Desktop is starting.
  • STOPPING: Desktop is stopping.
  • STOPPED: Desktop is stopped.
  • ERROR: Desktop did not manage start or restart.
  • CREATION_FAILED: Desktop did not manage to get created or updated.

name

string

Name of the desktop.

resources

Resources

Resources of the desktop.

networkInterfaces[]

NetworkInterface

users[]

User

labels

object (map<string, string>)

Labels of the desktop.

Resources

Field

Description

memory

string (int64)

cores

string (int64)

coreFraction

string (int64)

NetworkInterface

Field

Description

networkId

string

Required field.

subnetId

string

Required field.

User

Field

Description

subjectId

string

Required field. Identity of the access binding.

subjectType

string

Required field. Type of the access binding, e.g. userAccount, serviceAccount, system.
Previous
Overview
Next
GetRdpFile