Sign in
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

SOCA username for authentication

X-EDH-TOKENstring required

SOCA authentication token

Response

Session states retrieved successfully

successboolean required
messageobject required

Dictionary mapping session UUIDs to their state objects

Example response

{
  "success": true,
  "message": {
    "12345678-1234-1234-1234-123456789abc": {
      "state": "running",
      "ssm_ping": "Online",
      "instance_id": "i-0abc123def456",
      "instance_private_ip": "10.0.1.100",
      "instance_private_dns": "ip-10-0-1-100.ec2.internal"
    }
  }
}

Changes