Contact UsGet started

Cloud Desktop API, REST: Desktop.Create

Written by
Updated at April 24, 2025

Creates desktop in the specified folder.

HTTP request

POST https://cloud-desktop.api.cloud.yandex.net/cloud-desktop/v1/desktops

Body parameters

{
  "desktopGroupId": "string",
  "subnetId": "string",
  "users": [
    {
      "subjectId": "string",
      "subjectType": "string"
    }
  ]
}

Field

Description

desktopGroupId

string

Required field. ID of the desktop group.

subnetId

string

ID of the subnet for desktop.

users[]

User

List of users.

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.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "desktopId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "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"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

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

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateDesktopMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Desktop

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateDesktopMetadata

Field

Description

desktopId

string

ID of the desktop that is being created.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Desktop

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
ListOperations
Next
UpdateProperties