RD Sessions

Last updated 10 months ago

Was this helpful?

List

Retrieve one or multiple RD Sessions, from different sources such as RDS, VDI, and AVD.

get

/api/RDSession

Query parameters

SiteIdinteger int32

Site ID from which to retrieve the RD session information (optional).

Sourceenum

RDP Session Type

Options: 1 = RDS,2 = VDI,63 = AVD,-1 = All

ServerIdinteger int32

The Host ID of the server for which to retrieve the information (optional).

Serverstring

The name of the server to filter the RD Session information (optional).

Stateenum

Session State

Options:

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

Userstring

User to filter the RD Session information (optional).

IPstring

IP Address to filter the RD Session information (optional).

ThemeIdinteger int32

The Theme ID for which to retrieve the information (optional).

GroupIdinteger int32

The RD Session Host Group ID for which to retrieve the RD session information (optional).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDSession'

200

401

404