AWaws-samples
Virtual Desktops

Create virtual desktop profile

Changed on

Creates a new virtual desktop profile with specified configuration (admin access required)

post/api/dcv/virtual_desktops/profiles

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 application/x-www-form-urlencoded

profile_namestring required

Name for the virtual desktop profile

pattern_allowed_instance_typesstring required

Comma-separated patterns for allowed EC2 instance types

allowed_subnet_idsstring required

Comma-separated list of allowed subnet IDs

max_root_sizestring required

Maximum root volume size in GB

descriptionstring required

Profile description (max 500 characters)

Example request

{
  "profile_name": "Engineering Profile",
  "pattern_allowed_instance_types": "m5.*,c5.*,r5.*",
  "allowed_subnet_ids": "subnet-12345678,subnet-87654321",
  "max_root_size": "100",
  "description": "Profile for engineering workloads with high compute requirements"
}

Response

Virtual desktop profile created successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Engineering Profile registered successfully in SOCA"
}

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

  • 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