AWaws-samples
Virtual Desktops

List all virtual desktop sessions

Changed on

Retrieves detailed information about all active DCV virtual desktop sessions (admin access required)

get/api/dcv/virtual_desktops/list_all

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 (must be admin)

X-EDH-TOKENstring required

SOCA authentication token

Response

All virtual desktop sessions retrieved successfully

successboolean required
messageobject required

Dictionary of session UUIDs mapped to session details

Example response

{
  "success": true
}

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