AWaws-samples
Virtual Desktops

Create software stack

Changed on

Creates a new software stack from an AMI for virtual desktop deployment (admin access required)

post/api/dcv/virtual_desktops/software_stacks

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
Example:admin.user

SOCA username for authentication (must be admin)

X-EDH-TOKENstring required
Example:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

SOCA authentication token

Request body multipart/form-data

ami_idstring required

AMI ID to use for the software stack

stack_namestring required

Name for the software stack

base_osstring required

Base operating system type

root_sizestring required

Root volume size in GB

virtual_desktop_profile_idstring required

ID of the virtual desktop profile to associate

launch_tenancy'default' | 'dedicated' | 'host'

EC2 launch tenancy

launch_hoststring

Dedicated host ID (only for host tenancy)

descriptionstring

Description of the software stack (max 500 characters)

thumbnailstring binary

Thumbnail image for the software stack

share_scope'none' | 'project' | 'cluster'

Visibility scope for the software stack (default cluster)

Example request

{
  "ami_id": "ami-12345678",
  "stack_name": "Ubuntu Desktop 20.04",
  "base_os": "ubuntu2004",
  "root_size": "50",
  "virtual_desktop_profile_id": "1",
  "launch_tenancy": "default",
  "launch_host": "h-1234567890abcdef0",
  "description": "Ubuntu 20.04 with desktop environment and development tools"
}

Response

Software stack created successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "ami-12345678 registered successfully in SOCA as Ubuntu Desktop 20.04"
}

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

  • 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