AWaws-samples
Virtual Desktops

List user's virtual desktop sessions

Changed on

Retrieves DCV desktop sessions for the authenticated user with optional filtering

get/api/dcv/virtual_desktops/list

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

is_active'true' | 'false' required

Filter sessions by active status

session_uuidstring uuid

Filter by specific session UUID

state'pending' | 'running' | 'stopped' | 'stopping' | 'terminated'

Filter by session state

Headers

X-EDH-USERstring required

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Response

Successfully retrieved virtual desktop sessions

successboolean required
messageobject required

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