v1

latestOpenAPI 3.1.0Apache 2.02026-07-17870411.0 KB
Virtual Desktops

Get session states for virtual desktops

Retrieves the current state of one or more DCV virtual desktop sessions

get/api/dcv/virtual_desktops/session_state

Query parameters

session_uuidstring required

Comma-separated list of session UUIDs to check

Headers

X-EDH-USERstring required

EDH username for authentication

X-EDH-TOKENstring required

EDH authentication token

Response

Session states retrieved successfully

successboolean required
messageobject required

Dictionary mapping session UUIDs to their states

Example response

{
  "success": true,
  "message": {
    "12345678-1234-1234-1234-123456789abc": "running",
    "87654321-4321-4321-4321-cba987654321": "stopped"
  }
}