Sessions

List Sessions by Site ID

Retrieve the list of all sessions.

GET/api/RDS/Host/sessions

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session 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

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

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

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

Request

JavaScriptCurlPython

const response = await fetch('/api/RDS/Host/sessions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "ip": "text",
    "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",
    "connectionMode": [
      "0 = GatewayMode",
      "1 = DirectMode",
      "2 = GatewaySSLMode",
      "3 = DirectSSLMode",
      "4 = DirectRDPMode",
      "200 = Unknown"
    ],
    "authenticationType": [
      "0 = None",
      "1 = Credentials",
      "2 = SCard",
      "3 = SAML"
    ],
    "idleStartTime": "2024-11-07T07:34:29.243Z",
    "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"
    ],
    "rfiInfoList": [
      {
        "type": [
          "0 = Unknown",
          "1 = HALBInst",
          "2 = Gateway",
          "3 = ForwardingGateway",
          "4 = HALBDevice",
          "5 = HTML5",
          "6 = Other",
          "7 = AVDGateway"
        ],
        "ip": "text"
      }
    ],
    "userProfileType": [
      "0 = Unknown",
      "1 = Others",
      "2 = UPD",
      "3 = FSLogix"
    ],
    "connectionQuality": [
      "0 = None",
      "1 = Poor",
      "2 = Fair",
      "3 = Good",
      "4 = Excellent"
    ],
    "protocol": [
      "0 = Console",
      "2 = RDP",
      "10 = RDP_UDP"
    ],
    "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": "2024-11-07T07:34:29.243Z",
    "colourDepth": [
      "1 = COLOURDEPTH_4BIT",
      "2 = COLOURDEPTH_8BIT",
      "4 = COLOURDEPTH_16BIT",
      "8 = COLOURDEPTH_3BYTE",
      "16 = COLOURDEPTH_15BIT",
      "24 = COLOURDEPTH_24BIT",
      "32 = COLOURDEPTH_32BIT"
    ],
    "deviceName": "text",
    "clientIPAddress": "text",
    "clientOS": "text",
    "clientOSVersion": "text",
    "clientVersion": "text"
  }
]

List Sessions Status by Server ID

Retrieve a list of sessions for a specified RDS.

GET/api/RDS/Host/{id}/sessions

Path parameters

id*integer (int32)

RD Session Host ID

Response

200401404

Success

Body

application/json; api-version=1.0

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session 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

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

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

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

Request

JavaScriptCurlPython

const response = await fetch('/api/RDS/Host/{id}/sessions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "ip": "text",
    "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",
    "connectionMode": [
      "0 = GatewayMode",
      "1 = DirectMode",
      "2 = GatewaySSLMode",
      "3 = DirectSSLMode",
      "4 = DirectRDPMode",
      "200 = Unknown"
    ],
    "authenticationType": [
      "0 = None",
      "1 = Credentials",
      "2 = SCard",
      "3 = SAML"
    ],
    "idleStartTime": "2024-11-07T07:34:29.243Z",
    "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"
    ],
    "rfiInfoList": [
      {
        "type": [
          "0 = Unknown",
          "1 = HALBInst",
          "2 = Gateway",
          "3 = ForwardingGateway",
          "4 = HALBDevice",
          "5 = HTML5",
          "6 = Other",
          "7 = AVDGateway"
        ],
        "ip": "text"
      }
    ],
    "userProfileType": [
      "0 = Unknown",
      "1 = Others",
      "2 = UPD",
      "3 = FSLogix"
    ],
    "connectionQuality": [
      "0 = None",
      "1 = Poor",
      "2 = Fair",
      "3 = Good",
      "4 = Excellent"
    ],
    "protocol": [
      "0 = Console",
      "2 = RDP",
      "10 = RDP_UDP"
    ],
    "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": "2024-11-07T07:34:29.243Z",
    "colourDepth": [
      "1 = COLOURDEPTH_4BIT",
      "2 = COLOURDEPTH_8BIT",
      "4 = COLOURDEPTH_16BIT",
      "8 = COLOURDEPTH_3BYTE",
      "16 = COLOURDEPTH_15BIT",
      "24 = COLOURDEPTH_24BIT",
      "32 = COLOURDEPTH_32BIT"
    ],
    "deviceName": "text",
    "clientIPAddress": "text",
    "clientOS": "text",
    "clientOSVersion": "text",
    "clientVersion": "text"
  }
]

Get Sessions Status

Retrieve a specific session.

GET/api/RDS/Host/{id}/sessions/{sessionId}

Path parameters

id*integer (int32)

The ID of the RD Session Host server.

sessionId*integer (int32)

The ID of a specific session.

Response

200401404

Success

Body

application/json; api-version=1.0

sessionIDinteger (int32)

RAS session ID.

ipnullable string

Session server IP.

serverIDinteger (int32)

Session server ID.

typeSessionType (enum)

Session 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

usernullable string

User to which the session belongs to.

themeIDinteger (int32)

Theme ID.

connectionModeConnMode (enum)

Connection Mode.

0 = GatewayMode,1 = DirectMode,2 = GatewaySSLMode,3 = DirectSSLMode,4 = DirectRDPMode,200 = Unknown

authenticationTypeMainAuthenticationMode (enum)

Main Authentication Mode.

0 = None,1 = Credentials,2 = SCard,3 = SAML

idleStartTimenullable string (date-time)

Session Idle Time.

mfaProviderProviderType (enum)

Provider Type

0 = None,1 = Deepnet,2 = SafeNet,3 = Radius,4 = AzureRadius,5 = DuoRadius,6 = FortiRadius,7 = TekRadius,8 = GAuthTOTP,9 = TOTP,10 = MicrosoftTOTP,11 = EmailOTP

rfiCountinteger (int32)

Flow Information Count.

rfiInfoListnullable array of RouteFlowInfoEntry (object)

Flow Information.

logonDurationinteger (int32)

Logon Duration.

connectionDurationinteger (int32)

Connection Duration (in seconds).

authenticationDurationinteger (int32)

Authentication Duration (in seconds).

rasPolicyLookupinteger (int32)

RAS Policy Lookup (in ms).

hostPreparationinteger (int32)

Host Preparation (in ms).

groupPolicyLoadTimeinteger (int32)

Group Policy Load Time (in ms).

userProfileLoadTimeinteger (int32)

User Profile Load Time (in ms).

desktopLoadTimeinteger (int32)

Desktop Load Time (in ms).

logonOthersDurationinteger (int32)

Logon Others Duration (in seconds).

userProfileTypeUserProfileType (enum)

User Profile Type.

0 = Unknown,1 = Others,2 = UPD,3 = FSLogix

uxEvaluatorinteger (int32)

Round Trip Time.

connectionQualityQualityLevel (enum)

Connection Quality Level.

0 = None,1 = Poor,2 = Fair,3 = Good,4 = Excellent

latencyinteger (int32)

Latency.

protocolSessionProtocol (enum)

Session Protocol

0 = Console,2 = RDP,10 = RDP_UDP

bandwidthAvailabilityinteger (int32)

Bandwidth Availability (in Kbps).

lastReconnectsinteger (int32)

Last Reconnects.

reconnectsinteger (int32)

Total Reconnects.

disconnectReasonnullable string

Disconnect Reason.

stateSessionState (enum)

Session State

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

logonTimestring (date-time)

Session Logon Time.

sessionLengthinteger (int32)

Session Length (in seconds).

idleTimeinteger (int32)

Idle Time (in seconds).

incomingDatainteger (int32)

Incoming Data (in bytes).

outgoingDatainteger (int32)

Outgoing Data (in bytes).

verticalResolutioninteger (int32)

Session Vertical Resolution.

horizontalResolutioninteger (int32)

Session Horizontal Resolution.

colourDepthSessionColorDepth (enum)

Session Color Depth

1 = COLOURDEPTH_4BIT,2 = COLOURDEPTH_8BIT,4 = COLOURDEPTH_16BIT,8 = COLOURDEPTH_3BYTE,16 = COLOURDEPTH_15BIT,24 = COLOURDEPTH_24BIT,32 = COLOURDEPTH_32BIT

bandwidthUsageinteger (int32)

Bandwidth Usage.

deviceNamenullable string

Client Device Name.

clientIPAddressnullable string

Client IP Address.

clientOSnullable string

Client OS.

clientOSVersionnullable string

Client OS Version.

clientVersionnullable string

Client Version.

Request

JavaScriptCurlPython

const response = await fetch('/api/RDS/Host/{id}/sessions/{sessionId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "ip": "text",
  "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",
  "connectionMode": [
    "0 = GatewayMode",
    "1 = DirectMode",
    "2 = GatewaySSLMode",
    "3 = DirectSSLMode",
    "4 = DirectRDPMode",
    "200 = Unknown"
  ],
  "authenticationType": [
    "0 = None",
    "1 = Credentials",
    "2 = SCard",
    "3 = SAML"
  ],
  "idleStartTime": "2024-11-07T07:34:29.243Z",
  "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"
  ],
  "rfiInfoList": [
    {
      "type": [
        "0 = Unknown",
        "1 = HALBInst",
        "2 = Gateway",
        "3 = ForwardingGateway",
        "4 = HALBDevice",
        "5 = HTML5",
        "6 = Other",
        "7 = AVDGateway"
      ],
      "ip": "text"
    }
  ],
  "userProfileType": [
    "0 = Unknown",
    "1 = Others",
    "2 = UPD",
    "3 = FSLogix"
  ],
  "connectionQuality": [
    "0 = None",
    "1 = Poor",
    "2 = Fair",
    "3 = Good",
    "4 = Excellent"
  ],
  "protocol": [
    "0 = Console",
    "2 = RDP",
    "10 = RDP_UDP"
  ],
  "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": "2024-11-07T07:34:29.243Z",
  "colourDepth": [
    "1 = COLOURDEPTH_4BIT",
    "2 = COLOURDEPTH_8BIT",
    "4 = COLOURDEPTH_16BIT",
    "8 = COLOURDEPTH_3BYTE",
    "16 = COLOURDEPTH_15BIT",
    "24 = COLOURDEPTH_24BIT",
    "32 = COLOURDEPTH_32BIT"
  ],
  "deviceName": "text",
  "clientIPAddress": "text",
  "clientOS": "text",
  "clientOSVersion": "text",
  "clientVersion": "text"
}