Sessions

List Sessions by Site ID

get

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
chevron-right
200

Success

application/json; api-version=1.0

Remote Desktop Session

sessionIDinteger · int32Optional

RAS session ID.

ipstring · nullableOptional

Session server IP.

serverIDinteger · int32Optional

Session server ID.

typestring · enumOptional

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

get
/api/RDS/Host/sessions

List Sessions Status by Server ID

get

Retrieve a list of sessions for a specified RDS.

Path parameters
idinteger · int32Required

RD Session Host ID

Responses
chevron-right
200

Success

application/json; api-version=1.0

Remote Desktop Session

sessionIDinteger · int32Optional

RAS session ID.

ipstring · nullableOptional

Session server IP.

serverIDinteger · int32Optional

Session server ID.

typestring · enumOptional

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

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

Get Sessions Status

get

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
chevron-right
200

Success

application/json; api-version=1.0

Remote Desktop Session

sessionIDinteger · int32Optional

RAS session ID.

ipstring · nullableOptional

Session server IP.

serverIDinteger · int32Optional

Session server ID.

typestring · enumOptional

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

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