RD Sessions

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).

SourceRDSessionSource (enum)

RDP Session Type

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).

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

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).

Response

Success

Body

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.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

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.

sourceRDSessionSource (enum)

RDP Session Type

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

vmidnullable string

VM ID to which a VDI Remote Desktop Session is connected to.

vmNamenullable string

VM Name to which a VDI Remote Desktop Session is connected to.

sessionHostIdnullable string

Session Host ID to which a Remote Desktop Session is connected to.

sessionHostNamenullable string

Session Host Name to which a Remote Desktop Session is connected to.

poolNamenullable string

Group/Pool Name.

templateNamenullable string

Template Name.

fsLogixReasonCodeFSLogixReasonCode (enum)

FSLogix Reason Code values.

0 = ProfileAttached,1 = NotInWhiteList,2 = InBlackList,3 = LocalProfileExists,4 = ProfileShortSid,5 = Unknown

fsLogixStatusCodeFSLogixStatusCode (enum)

FSLogix Status Code values.

0 = Success,1 = Error,2 = VirtualDiskDLL,3 = GetUser,5 = Security,6 = VHDPath,7 = CreateDir,8 = Impersonation,9 = CreateVHD,10 = CloseHandle,11 = OpenVHD,12 = AttachVHD,13 = GetPhysicalPath,14 = OpenDevice,15 = InitializeDisk,16 = GetVolumeGUID,17 = FormatVolume,18 = GetProfileDirectory,19 = SetMountPoint,20 = RegistryImport,21 = CheckGroupMembership,22 = HandleProfile,23 = ProfileSubfolderRedirection,100 = WaitingCreationOfUserProfile,200 = InProgress,300 = AlreadyAttached

Request

Response

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).

SourceRDSessionSource (enum)

RDP Session Type

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).

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

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).

Response

Success

Body

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.

typeRouteFlowHopType (enum)

Route Flow Hop Type.

0 = Unknown,1 = HALBInst,2 = Gateway,3 = ForwardingGateway,4 = HALBDevice,5 = HTML5,6 = Other,7 = AVDGateway

ipnullable string

IP.

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.

sourceRDSessionSource (enum)

RDP Session Type

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

vmidnullable string

VM ID to which a VDI Remote Desktop Session is connected to.

vmNamenullable string

VM Name to which a VDI Remote Desktop Session is connected to.

sessionHostIdnullable string

Session Host ID to which a Remote Desktop Session is connected to.

sessionHostNamenullable string

Session Host Name to which a Remote Desktop Session is connected to.

poolNamenullable string

Group/Pool Name.

templateNamenullable string

Template Name.

fsLogixReasonCodeFSLogixReasonCode (enum)

FSLogix Reason Code values.

0 = ProfileAttached,1 = NotInWhiteList,2 = InBlackList,3 = LocalProfileExists,4 = ProfileShortSid,5 = Unknown

fsLogixStatusCodeFSLogixStatusCode (enum)

FSLogix Status Code values.

Request

Response

[
  {
    "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-07T10:16:14.023Z",
    "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-07T10:16:14.023Z",
    "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",
    "source": [
      "1 = RDS",
      "2 = VDI",
      "63 = AVD",
      "-1 = All"
    ],
    "vmid": "text",
    "vmName": "text",
    "sessionHostId": "text",
    "sessionHostName": "text",
    "poolName": "text",
    "templateName": "text",
    "fsLogixReasonCode": [
      "0 = ProfileAttached",
      "1 = NotInWhiteList",
      "2 = InBlackList",
      "3 = LocalProfileExists",
      "4 = ProfileShortSid",
      "5 = Unknown"
    ],
    "fsLogixStatusCode": [
      "0 = Success",
      "1 = Error",
      "2 = VirtualDiskDLL",
      "3 = GetUser",
      "5 = Security",
      "6 = VHDPath",
      "7 = CreateDir",
      "8 = Impersonation",
      "9 = CreateVHD",
      "10 = CloseHandle",
      "11 = OpenVHD",
      "12 = AttachVHD",
      "13 = GetPhysicalPath",
      "14 = OpenDevice",
      "15 = InitializeDisk",
      "16 = GetVolumeGUID",
      "17 = FormatVolume",
      "18 = GetProfileDirectory",
      "19 = SetMountPoint",
      "20 = RegistryImport",
      "21 = CheckGroupMembership",
      "22 = HandleProfile",
      "23 = ProfileSubfolderRedirection",
      "100 = WaitingCreationOfUserProfile",
      "200 = InProgress",
      "300 = AlreadyAttached"
    ]
  }
]