AWaws-samples
Virtual Desktops

Get virtual desktop profiles

Changed on

Retrieves virtual desktop profiles, optionally filtered by profile ID (admin access required)

get/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)

Query parameters

profile_idstring
Example:1

Specific profile ID to retrieve (returns all if not specified)

Headers

X-EDH-USERstring required
Example:admin.user

SOCA username for authentication (must be admin)

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

SOCA authentication token

Response

Virtual desktop profiles retrieved successfully

successboolean

Example response

{
  "success": true,
  "message": "No Virtual Desktop Profiles found"
}

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