Sessions
Retrieve the list of all sessions.
Site ID of which the sessions will be retrieved (optional)
Filter the result by server name (optional)
Success
Remote Desktop Session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Unauthorized
Not Found
GET /api/RDS/Host/sessions HTTP/1.1
Accept: */*
[
{
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2026-01-01T00:00:00.000Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2026-01-01T00:00:00.000Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text"
}
]Retrieve a list of sessions for a specified RDS.
RD Session Host ID
Success
Remote Desktop Session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Unauthorized
Not Found
GET /api/RDS/Host/{id}/sessions HTTP/1.1
Accept: */*
[
{
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2026-01-01T00:00:00.000Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2026-01-01T00:00:00.000Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text"
}
]Retrieve a specific session.
The ID of the RD Session Host server.
The ID of a specific session.
Success
Remote Desktop Session
RAS session ID.
Session server IP.
Session server ID.
Session Type
User to which the session belongs to.
Theme ID.
Connection Mode.
Main Authentication Mode.
Session Idle Time.
Provider Type
Flow Information Count.
Logon Duration.
Connection Duration (in seconds).
Authentication Duration (in seconds).
RAS Policy Lookup (in ms).
Host Preparation (in ms).
Group Policy Load Time (in ms).
User Profile Load Time (in ms).
Desktop Load Time (in ms).
Logon Others Duration (in seconds).
User Profile Type.
Round Trip Time.
Connection Quality Level.
Latency.
Session Protocol
Bandwidth Availability (in Kbps).
Last Reconnects.
Total Reconnects.
Disconnect Reason.
Session State
Session Logon Time.
Session Length (in seconds).
Idle Time (in seconds).
Incoming Data (in bytes).
Outgoing Data (in bytes).
Session Vertical Resolution.
Session Horizontal Resolution.
Session Color Depth
Bandwidth Usage.
Client Device Name.
Client IP Address.
Client OS.
Client OS Version.
Client Version.
Unauthorized
Not Found
GET /api/RDS/Host/{id}/sessions/{sessionId} HTTP/1.1
Accept: */*
{
"sessionID": 1,
"ip": "text",
"serverID": 1,
"type": [
"0 = Desktop",
"1 = PublishedApps",
"2 = Application",
"3 = VDI",
"4 = VDIApp",
"5 = PC",
"6 = PCApp",
"7 = Admin",
"8 = Unknown",
"9 = RemoteApps",
"10 = DirectRDP",
"-1 = All"
],
"user": "text",
"themeID": 1,
"connectionMode": [
"0 = GatewayMode",
"1 = DirectMode",
"2 = GatewaySSLMode",
"3 = DirectSSLMode",
"4 = DirectRDPMode",
"200 = Unknown"
],
"authenticationType": [
"0 = None",
"1 = Credentials",
"2 = SCard",
"3 = SAML"
],
"idleStartTime": "2026-01-01T00:00:00.000Z",
"mfaProvider": [
"0 = None",
"1 = Deepnet",
"2 = SafeNet",
"3 = Radius",
"4 = AzureRadius",
"5 = DuoRadius",
"6 = FortiRadius",
"7 = TekRadius",
"8 = GAuthTOTP",
"9 = TOTP",
"10 = MicrosoftTOTP",
"11 = EmailOTP"
],
"rfiCount": 1,
"rfiInfoList": [
{
"type": [
"0 = Unknown",
"1 = HALBInst",
"2 = Gateway",
"3 = ForwardingGateway",
"4 = HALBDevice",
"5 = HTML5",
"6 = Other",
"7 = AVDGateway"
],
"ip": "text"
}
],
"logonDuration": 1,
"connectionDuration": 1,
"authenticationDuration": 1,
"rasPolicyLookup": 1,
"hostPreparation": 1,
"groupPolicyLoadTime": 1,
"userProfileLoadTime": 1,
"desktopLoadTime": 1,
"logonOthersDuration": 1,
"userProfileType": [
"0 = Unknown",
"1 = Others",
"2 = UPD",
"3 = FSLogix"
],
"uxEvaluator": 1,
"connectionQuality": [
"0 = None",
"1 = Poor",
"2 = Fair",
"3 = Good",
"4 = Excellent"
],
"latency": 1,
"protocol": [
"0 = Console",
"2 = RDP",
"10 = RDP_UDP"
],
"bandwidthAvailability": 1,
"lastReconnects": 1,
"reconnects": 1,
"disconnectReason": "text",
"state": [
"0 = Active",
"1 = Connected",
"2 = ConnectQuery",
"3 = Shadow",
"4 = Disconnected",
"5 = Idle",
"6 = Listen",
"7 = Reset",
"8 = Down",
"9 = Init",
"-1 = All"
],
"logonTime": "2026-01-01T00:00:00.000Z",
"sessionLength": 1,
"idleTime": 1,
"incomingData": 1,
"outgoingData": 1,
"verticalResolution": 1,
"horizontalResolution": 1,
"colourDepth": [
"1 = COLOURDEPTH_4BIT",
"2 = COLOURDEPTH_8BIT",
"4 = COLOURDEPTH_16BIT",
"8 = COLOURDEPTH_3BYTE",
"16 = COLOURDEPTH_15BIT",
"24 = COLOURDEPTH_24BIT",
"32 = COLOURDEPTH_32BIT"
],
"bandwidthUsage": 1,
"deviceName": "text",
"clientIPAddress": "text",
"clientOS": "text",
"clientOSVersion": "text",
"clientVersion": "text"
}