Cloud Desktop API, REST: DesktopGroup.Get

Written by

Updated at October 30, 2025

HTTP request
Path parameters
Response
ResourcesSpec
NetworkInterfaceSpec
DiskSpec
DesktopGroupConfiguration
Subject

Returns the specified desktop group resource.

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

HTTP request

GET https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktopGroups/{desktopGroupId}

Path parameters

Field

Description

desktopGroupId

string

Required field. ID of the desktop group resource to return.

To get the desktop group ID use a DesktopGroupService.List request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "status": "string",
  "name": "string",
  "description": "string",
  "resourcesSpec": {
    "memory": "string",
    "cores": "string",
    "coreFraction": "string"
  },
  "networkInterfaceSpec": {
    "networkId": "string",
    "subnetIds": [
      "string"
    ]
  },
  "labels": "object",
  "bootDiskSpec": {
    "type": "string",
    "size": "string"
  },
  "dataDiskSpec": {
    "type": "string",
    "size": "string"
  },
  "groupConfig": {
    "minReadyDesktops": "string",
    "maxDesktopsAmount": "string",
    "desktopType": "string",
    "members": [
      {
        "id": "string",
        "type": "string"
      }
    ]
  },
  // Includes only one of the fields `autoUpdatePolicy`, `manualUpdatePolicy`
  "autoUpdatePolicy": "object",
  "manualUpdatePolicy": "object"
  // end of the list of possible fields
}

A desktop group resource.

Field	Description
id	string Desktop group ID.
folderId	string ID of the folder that the desktop group 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 group. `STATUS_UNSPECIFIED` `CREATING`: Desktop group is being created. `ACTIVE`: Desktop group is ready to use. `DELETING`: Desktop group is being deleted. `UPDATING`: Desktop group is updating.
name	string Name of the desktop group.
description	string Description of the desktop group.
resourcesSpec	ResourcesSpec Resource specification of the desktop group.
networkInterfaceSpec	NetworkInterfaceSpec Network interface specification of the desktop group.
labels	object (map<string, string>) Labels of the desktop group.
bootDiskSpec	DiskSpec Boot disk specification of the desktop group.
dataDiskSpec	DiskSpec Data disk specification of the desktop group.
groupConfig	DesktopGroupConfiguration Desktop group configuration.
autoUpdatePolicy	object Includes only one of the fields `autoUpdatePolicy`, `manualUpdatePolicy`. Desktop group update policy.
manualUpdatePolicy	object Includes only one of the fields `autoUpdatePolicy`, `manualUpdatePolicy`. Desktop group update policy.

ResourcesSpec

Field	Description
memory	string (int64) RAM volume, in bytes.
cores	string (int64) Number of CPU cores.
coreFraction	string (int64) Baseline level of CPU performance with the ability to burst performance above that baseline level. This field sets baseline performance for each core.

NetworkInterfaceSpec

Field

Description

networkId

string

Required field. ID of the network interface specification.

subnetIds[]

string

List of subnet IDs.

DiskSpec

Disk specificaton.

Field

Description

type

enum (Type)

Required field. Type of disk.

TYPE_UNSPECIFIED: Disk type is not specified.
HDD: HDD disk type.
SSD: SSD disk type.

size

string (int64)

Size of disk.

DesktopGroupConfiguration

Field	Description
minReadyDesktops	string (int64) Minimum number of ready desktops.
maxDesktopsAmount	string (int64) Maximum number of desktops.
desktopType	enum (DesktopType) Type of the desktop. `DESKTOP_TYPE_UNSPECIFIED` `PERSISTENT` `NON_PERSISTENT`
members[]	Subject List of members of the desktop group.

Subject

Field

Description

string

Required field. ID of the subject.

It can contain one of the following values:

allAuthenticatedUsers: A special public group that represents anyone
who is authenticated. It can be used only if the type is system.
allUsers: A special public group that represents anyone. No authentication is required.
For example, you don't need to specify the IAM token in an API query.
It can be used only if the type is system.
group:organization:<id>:users: A special system group that represents all members of organization
with given <id>. It can be used only if the type is system.
group:federation:<id>:users: A special system group that represents all users of federation
with given <id>. It can be used only if the type is system.
<cloud generated id>: An identifier that represents a user account.
It can be used only if the type is userAccount, federatedUser or serviceAccount.

type

string

Required field. Type of the subject.

It can contain one of the following values:

userAccount: An account on Yandex or Yandex Connect, added to Yandex Cloud.
serviceAccount: A service account. This type represents the yandex.cloud.iam.v1.ServiceAccount resource.
federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory.
system: System group. This type represents several accounts with a common system identifier.

For more information, see Subject to which the role is assigned.

Cloud Desktop API, REST: DesktopGroup.Get

HTTP requestHTTP request

Path parametersPath parameters

ResponseResponse

ResourcesSpecResourcesSpec

NetworkInterfaceSpecNetworkInterfaceSpec

DiskSpecDiskSpec

DesktopGroupConfigurationDesktopGroupConfiguration

SubjectSubject

Was the article helpful?

HTTP request

Path parameters

Response

ResourcesSpec

NetworkInterfaceSpec

DiskSpec

DesktopGroupConfiguration

Subject