RD Sessions

List

get

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

Query parameters

SiteIdinteger · int32Optional

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

Sourcestring · enumOptional

RDP Session Type

Possible values:

ServerIdinteger · int32Optional

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

ServerstringOptional

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

Statestring · enumOptional

Session State

Possible values:

UserstringOptional

User to filter the RD Session information (optional).

IPstringOptional

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

ThemeIdinteger · int32Optional

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

GroupIdinteger · int32Optional

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

Responses

200

Success

application/json; api-version=1.0

User session type

sessionIDinteger · int32Optional

RAS session ID.

ipstring · nullableOptional

Session server IP.

serverIDinteger · int32Optional

Session server ID.

typestring · enumOptional

Session Publishing Type

Possible values:

userstring · nullableOptional

User to which the session belongs to.

themeIDinteger · int32Optional

Theme ID.

connectionModestring · enumOptional

Connection Mode.

Possible values:

authenticationTypestring · enumOptional

Main Authentication Mode.

Possible values:

idleStartTimestring · date-time · nullableOptional

Session Idle Time.

mfaProviderstring · enumOptional

Provider Type

Possible values:

rfiCountinteger · int32Optional

Flow Information Count.

logonDurationinteger · int32Optional

Logon Duration.

connectionDurationinteger · int32Optional

Connection Duration (in seconds).

authenticationDurationinteger · int32Optional

Authentication Duration (in seconds).

rasPolicyLookupinteger · int32Optional

RAS Policy Lookup (in ms).

hostPreparationinteger · int32Optional

Host Preparation (in ms).

groupPolicyLoadTimeinteger · int32Optional

Group Policy Load Time (in ms).

userProfileLoadTimeinteger · int32Optional

User Profile Load Time (in ms).

desktopLoadTimeinteger · int32Optional

Desktop Load Time (in ms).

logonOthersDurationinteger · int32Optional

Logon Others Duration (in seconds).

userProfileTypestring · enumOptional

User Profile Type.

Possible values:

uxEvaluatorinteger · int32Optional

Round Trip Time.

connectionQualitystring · enumOptional

Connection Quality Level.

Possible values:

latencyinteger · int32Optional

Latency.

protocolstring · enumOptional

Session Protocol

Possible values:

bandwidthAvailabilityinteger · int32Optional

Bandwidth Availability (in Kbps).

lastReconnectsinteger · int32Optional

Last Reconnects.

reconnectsinteger · int32Optional

Total Reconnects.

disconnectReasonstring · nullableOptional

Disconnect Reason.

statestring · enumOptional

Session State

Possible values:

logonTimestring · date-timeOptional

Session Logon Time.

sessionLengthinteger · int32Optional

Session Length (in seconds).

idleTimeinteger · int32Optional

Idle Time (in seconds).

incomingDatainteger · int32Optional

Incoming Data (in bytes).

outgoingDatainteger · int32Optional

Outgoing Data (in bytes).

verticalResolutioninteger · int32Optional

Session Vertical Resolution.

horizontalResolutioninteger · int32Optional

Session Horizontal Resolution.

colourDepthstring · enumOptional

Session Color Depth

Possible values:

bandwidthUsageinteger · int32Optional

Bandwidth Usage.

deviceNamestring · nullableOptional

Client Device Name.

clientIPAddressstring · nullableOptional

Client IP Address.

clientOSstring · nullableOptional

Client OS.

clientOSVersionstring · nullableOptional

Client OS Version.

clientVersionstring · nullableOptional

Client Version.

clientPolicyIdinteger · int32Optional

Client Policy Id.

clientPolicyVersioninteger · int32Optional

Client Policy Version.

sourcestring · enumOptional

RDP Session Type

Possible values:

vmidstring · nullableOptionalDeprecated

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

vmNamestring · nullableOptionalDeprecated

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

sessionHostIdstring · nullableOptional

Session Host ID to which a Session is connected to.

sessionHostNamestring · nullableOptional

Session Host Name to which a Session is connected to.

poolNamestring · nullableOptional

Group/Pool Name.

templateNamestring · nullableOptional

Template Name.

fsLogixReasonCodestring · enumOptional

FSLogix Reason Code values.

Possible values:

fsLogixStatusCodestring · enumOptional

FSLogix Status Code values.

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/RDSession

HTTPcURLJavaScriptPython

GET /api/RDSession HTTP/1.1
Accept: */*

[
  {
    "sessionID": 1,
    "ip": "text",
    "serverID": 1,
    "type": [
      "0 = Desktop",
      "1 = PublishedApps",
      "2 = Application",
      "7 = Admin",
      "8 = Unknown",
      "9 = RemoteApps",
      "10 = DirectRDP"
    ],
    "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",
      "4 = WebCredentials"
    ],
    "idleStartTime": "2026-03-10T16:35:12.461Z",
    "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-03-10T16:35:12.461Z",
    "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",
    "clientPolicyId": 1,
    "clientPolicyVersion": 1,
    "source": [
      "1 = RDS",
      "2 = VDI",
      "63 = AVD",
      "-1 = All"
    ],
    "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"
    ]
  }
]