1 of 6

Sessions

Disconnect

Logoff

Processes

Kill

Sendmsg

Send Message Session

Invoke the RD Session Host Session to send a message to the RD Session Host Session with specified Session ID.

POST/api/RDS/Host/{rdsId}/sessions/{id}/sendmsg

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

Session ID of the Session to be sent a message.

Body

RD Session Host Session

msgTitlenullable string

The message title for the session message.

messagenullable string

The session message to be sent.

Response

No Content

Request

Response

Sessions

List Sessions by Site ID

Retrieve the list of all sessions.

GET/api/RDS/Host/sessions

Query parameters

SiteIdinteger (int32)

Site ID of which the sessions will be retrieved (optional)

Serverstring

Filter the result by server name (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.

Request

Response

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

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.

Request

Response

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

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.

Request

Response

Disconnect

Disconnect Session

Invoke the RD Session Host Session to send the Disconnect command to the RD Session Host Session with specified Session ID.

POST/api/RDS/Host/{rdsId}/sessions/{id}/disconnect

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

Session ID of the Session to be Disconnected.

Response

No Content

Request

Response

Processes

List

Retrieve the list of all processes for all the RD Session Host sessions.

GET/api/RDS/Host/sessions/processes

Query parameters

SiteIdinteger (int32)

Site ID for which processes for all the RD Session Host sessions will be retrieved (optional)

Serverstring

Filter the result by server name (optional)

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

List by Server ID

Retrieve the list of all processes for all the sessions of a specified RDS.

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

Path parameters

id*integer (int32)

Server ID for which processes for all the RD Session Host sessions will be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

List by Server ID and Session ID

Retrieve the list of all processes for a specified session of a specified RDS.

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

Path parameters

id*integer (int32)

Server ID for which processes of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which all processes will be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

Get

Retrieve a process with a specified PID for a specified session of a specified RD Session Host.

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

Path parameters

id*integer (int32)

Server ID for which a process of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which a specified process will be retrieved

pid*integer (int32)

ID of the process to be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

Logoff

LogOff Session

Invoke the RD Session Host to send the LogOff command to the session with specified ID.

POST/api/RDS/Host/{rdsId}/sessions/{id}/logoff

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

Session ID of the Session to be Logged Off.

Response

No Content

Request

Response

Send Message Session

Invoke the RD Session Host Session to send a message to the RD Session Host Session with specified Session ID.

POST/api/RDS/Host/{rdsId}/sessions/{id}/sendmsg

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

Session ID of the Session to be sent a message.

Body

RD Session Host Session

msgTitlenullable string

The message title for the session message.

messagenullable string

The session message to be sent.

Response

No Content

Request

Response

Disconnect Session

Invoke the RD Session Host Session to send the Disconnect command to the RD Session Host Session with specified Session ID.

POST/api/RDS/Host/{rdsId}/sessions/{id}/disconnect

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

Session ID of the Session to be Disconnected.

Response

No Content

Request

Response

LogOff Session

Invoke the RD Session Host to send the LogOff command to the session with specified ID.

POST/api/RDS/Host/{rdsId}/sessions/{id}/logoff

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

Session ID of the Session to be Logged Off.

Response

No Content

Request

Response

List by Server ID and Session ID

Retrieve the list of all processes for a specified session of a specified RDS.

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

Path parameters

id*integer (int32)

Server ID for which processes of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which all processes will be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

Get

Retrieve a process with a specified PID for a specified session of a specified RD Session Host.

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

Path parameters

id*integer (int32)

Server ID for which a process of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which a specified process will be retrieved

pid*integer (int32)

ID of the process to be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

List

Retrieve the list of all processes for all the RD Session Host sessions.

GET/api/RDS/Host/sessions/processes

Query parameters

SiteIdinteger (int32)

Site ID for which processes for all the RD Session Host sessions will be retrieved (optional)

Serverstring

Filter the result by server name (optional)

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

List by Server ID

Retrieve the list of all processes for all the sessions of a specified RDS.

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

Path parameters

id*integer (int32)

Server ID for which processes for all the RD Session Host sessions will be retrieved

Response

Success

Body

namenullable string

Published Item name.

appNamenullable string

Application name.

processnullable string

Process name.

pidinteger (int32)

Process ID.

usernullable string

User which is running the application.

sessioninteger (int32)

RAS session ID.

serverIDinteger (int32)

Server ID from where the application is hosted.

Request

Response

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

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.

Request

Response

List Sessions by Site ID

Retrieve the list of all sessions.

GET/api/RDS/Host/sessions

Query parameters

SiteIdinteger (int32)

Site ID of which the sessions will be retrieved (optional)

Serverstring

Filter the result by server name (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.

Request

Response

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

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.

Request

Response

const response = await fetch('/api/RDS/Host/{rdsId}/sessions/{id}/sendmsg', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

[
  {
    "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-07T09:58:50.923Z",
    "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-07T09:58:50.923Z",
    "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"
  }
]

[
  {
    "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-07T09:58:50.923Z",
    "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-07T09:58:50.923Z",
    "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"
  }
]

{
  "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-07T09:58:50.923Z",
  "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-07T09:58:50.923Z",
  "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"
}

Kill

Kill Process

Invoke the RD Session Host to send the kill command to a process with the specified ID.

POST/api/RDS/Host/{rdsId}/sessions/processes/{id}/kill

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

RD Session Host Process ID of the RD Session Host Process to be killed.

Response

No Content

Request

Response

Kill Process

Invoke the RD Session Host to send the kill command to a process with the specified ID.

POST/api/RDS/Host/{rdsId}/sessions/processes/{id}/kill

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

RD Session Host Process ID of the RD Session Host Process to be killed.

Response

No Content

Request

Response