v1

latestOpenAPI 3.1.0Apache 2.02026-07-17870411.0 KB
Virtual Desktops

List user's virtual desktop sessions

Retrieves DCV desktop sessions for the authenticated user with optional filtering

get/api/dcv/virtual_desktops/list

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

EDH username for authentication

X-EDH-TOKENstring required

EDH authentication token

Response

Successfully retrieved virtual desktop sessions

successboolean required
messageobject required

Example response

{
  "success": true
}