AWaws-samples
Virtual Desktops

Create new virtual desktop session

Changed on

Provisions a new EC2 instance with DCV for remote desktop access

post/api/dcv/virtual_desktops/create

Request

  • The document declares no server URL.
  • Auth
    socaAuth (a scheme the document does not define) and socaToken (a scheme the document does not define)

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Request body application/x-www-form-urlencoded

instance_typestring required

EC2 instance type for the virtual desktop

capacity_reservation_idstring

Existing Capacity Reservation ID to assign

disk_sizestring

EBS root volume size in GB

session_namestring required

Name for the DCV session (alphanumeric only, max 32 chars)

software_stack_idstring required

ID of the software stack to use

subnet_idstring

Subnet ID where to launch the EC2 instance

projectstring

Project to map the VDI desktop to

hibernate'true' | 'false'

Enable hibernation support

tenancy'default' | 'dedicated'

EC2 tenancy type

session_type'default' | 'console' | 'virtual'

Type of DCV session

nested_virtualization'true' | 'false'

Enable nested virtualization support (requires feature flag)

bootstrap_cache_bypass'true' | 'false'

Bypass the bootstrap template cache for this session (debugging)

on_behalf_ofstring

Admin-only - create session on behalf of another user

Example request

{
  "instance_type": "m5.large",
  "capacity_reservation_id": "cr-abd123",
  "disk_size": "50",
  "session_name": "MyDesktop01",
  "software_stack_id": "1",
  "subnet_id": "subnet-12345678",
  "project": "myproject",
  "hibernate": "false",
  "tenancy": "default",
  "session_type": "default",
  "nested_virtualization": "false",
  "bootstrap_cache_bypass": "false",
  "on_behalf_of": "another.user"
}

Response

Virtual desktop session creation initiated successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Session MyDesktop01 started successfully."
}

Changes

  • v1058396b8f0f1Revision changes
    • info

      the endpoint scheme security socaAuth AND socaToken was added to the API

    • info

      the endpoint scheme security edhAuth AND edhToken was removed from the API

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • v16db97cead8dfRevision changes
    • info

      the endpoint scheme security edhAuth AND edhToken was added to the API

    • info

      the endpoint scheme security socaAuth AND socaToken was removed from the API

    • info

      added the new optional request property