Sessions
Retrieve the list of all sessions.
Query parameters
SiteIdinteger · int32Optional
Site ID of which the sessions will be retrieved (optional)
ServerstringOptional
Filter the result by server name (optional)
Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/RDS/Host/sessions HTTP/1.1
Host:
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": "2025-07-03T01:20:24.444Z",
"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": "2025-07-03T01:20:24.444Z",
"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.
Path parameters
idinteger · int32Required
RD Session Host ID
Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/RDS/Host/{id}/sessions HTTP/1.1
Host:
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": "2025-07-03T01:20:24.444Z",
"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": "2025-07-03T01:20:24.444Z",
"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.
Path parameters
idinteger · int32Required
The ID of the RD Session Host server.
sessionIdinteger · int32Required
The ID of a specific session.
Responses
200
Success
application/json; api-version=1.0
401
Unauthorized
application/json; api-version=1.0
404
Not Found
application/json; api-version=1.0
get
GET /api/RDS/Host/{id}/sessions/{sessionId} HTTP/1.1
Host:
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": "2025-07-03T01:20:24.444Z",
"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": "2025-07-03T01:20:24.444Z",
"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"
}Was this helpful?