Status

List

Retrieve the status information of one or multiple applications, from different session sources such as RD Session Host and VDI.

GET/api/PubItems/status

Query parameters

Idinteger (int32)

Site ID from which to retrieve the app status information (optional).

SiteIdinteger (int32)

Site ID from which to retrieve the app status information (optional).

SourceRDSessionSource (enum)

RDP Session Type

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

SessionHostIdstring

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

SessionHostNamestring

The name of the server to filter the app status 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 app status information(optional).

IPstring

IP Address to filter the app status information (optional).

ThemeIdinteger (int32)

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

GroupIdinteger (int32)

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

Sessioninteger (int32)

The RD Session ID for which to retrieve the app status information (optional).

Response

Success

Body

processnullable string

Process name.

pidinteger (int32)

Process ID.

sessioninteger (int32)

RAS session ID.

idinteger (int32)

App/Desktop ID.

namenullable string

App/Desktop name.

executablePathnullable string

Executable application path.

sessionTypeSessionType (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

sourceRDSessionSource (enum)

RDP Session Type

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

sessionHostIdnullable string

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

sessionHostNamenullable string

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

poolNamenullable string

Group/Pool Name.

usernullable string

User which is running the application/desktop.

parentProcessIDinteger (int32)

ID of the parent process of the published item.

vdiDesktopRuntimeIdinteger (int32)

VDI Desktop Runtime ID of the process.

ipnullable string

Session server IP.

themeIDinteger (int32)

Theme ID.

sessionStateSessionState (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

Request

Response

Get

Retrieve the published item status information.

GET/api/PubItems/{id}/status

Path parameters

id*integer (int32)

Pub Item ID

Response

Success

Body

processnullable string

Process name.

pidinteger (int32)

Process ID.

sessioninteger (int32)

RAS session ID.

idinteger (int32)

App/Desktop ID.

namenullable string

App/Desktop name.

executablePathnullable string

Executable application path.

sessionTypeSessionType (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

sourceRDSessionSource (enum)

RDP Session Type

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

sessionHostIdnullable string

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

sessionHostNamenullable string

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

poolNamenullable string

Group/Pool Name.

usernullable string

User which is running the application/desktop.

parentProcessIDinteger (int32)

ID of the parent process of the published item.

vdiDesktopRuntimeIdinteger (int32)

VDI Desktop Runtime ID of the process.

ipnullable string

Session server IP.

themeIDinteger (int32)

Theme ID.

sessionStateSessionState (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

Request

Response

List

Retrieve the status information of one or multiple applications, from different session sources such as RD Session Host and VDI.

GET/api/PubItems/status

Query parameters

Idinteger (int32)

Site ID from which to retrieve the app status information (optional).

SiteIdinteger (int32)

Site ID from which to retrieve the app status information (optional).

SourceRDSessionSource (enum)

RDP Session Type

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

SessionHostIdstring

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

SessionHostNamestring

The name of the server to filter the app status 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 app status information(optional).

IPstring

IP Address to filter the app status information (optional).

ThemeIdinteger (int32)

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

GroupIdinteger (int32)

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

Sessioninteger (int32)

The RD Session ID for which to retrieve the app status information (optional).

Response

Success

Body

processnullable string

Process name.

pidinteger (int32)

Process ID.

sessioninteger (int32)

RAS session ID.

idinteger (int32)

App/Desktop ID.

namenullable string

App/Desktop name.

executablePathnullable string

Executable application path.

sessionTypeSessionType (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

sourceRDSessionSource (enum)

RDP Session Type

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

sessionHostIdnullable string

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

sessionHostNamenullable string

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

poolNamenullable string

Group/Pool Name.

usernullable string

User which is running the application/desktop.

parentProcessIDinteger (int32)

ID of the parent process of the published item.

vdiDesktopRuntimeIdinteger (int32)

VDI Desktop Runtime ID of the process.

ipnullable string

Session server IP.

themeIDinteger (int32)

Theme ID.

sessionStateSessionState (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

Request

Response

Get

Retrieve the published item status information.

GET/api/PubItems/{id}/status

Path parameters

id*integer (int32)

Pub Item ID

Response

Success

Body

processnullable string

Process name.

pidinteger (int32)

Process ID.

sessioninteger (int32)

RAS session ID.

idinteger (int32)

App/Desktop ID.

namenullable string

App/Desktop name.

executablePathnullable string

Executable application path.

sessionTypeSessionType (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

sourceRDSessionSource (enum)

RDP Session Type

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

sessionHostIdnullable string

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

sessionHostNamenullable string

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

poolNamenullable string

Group/Pool Name.

usernullable string

User which is running the application/desktop.

parentProcessIDinteger (int32)

ID of the parent process of the published item.

vdiDesktopRuntimeIdinteger (int32)

VDI Desktop Runtime ID of the process.

ipnullable string

Session server IP.

themeIDinteger (int32)

Theme ID.

sessionStateSessionState (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

Request

Response

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

[
  {
    "process": "text",
    "name": "text",
    "executablePath": "text",
    "sessionType": [
      "0 = Desktop",
      "1 = PublishedApps",
      "2 = Application",
      "3 = VDI",
      "4 = VDIApp",
      "5 = PC",
      "6 = PCApp",
      "7 = Admin",
      "8 = Unknown",
      "9 = RemoteApps",
      "10 = DirectRDP",
      "-1 = All"
    ],
    "source": [
      "1 = RDS",
      "2 = VDI",
      "63 = AVD",
      "-1 = All"
    ],
    "sessionHostId": "text",
    "sessionHostName": "text",
    "poolName": "text",
    "user": "text",
    "ip": "text",
    "sessionState": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ]
  }
]

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

[
  {
    "process": "text",
    "name": "text",
    "executablePath": "text",
    "sessionType": [
      "0 = Desktop",
      "1 = PublishedApps",
      "2 = Application",
      "3 = VDI",
      "4 = VDIApp",
      "5 = PC",
      "6 = PCApp",
      "7 = Admin",
      "8 = Unknown",
      "9 = RemoteApps",
      "10 = DirectRDP",
      "-1 = All"
    ],
    "source": [
      "1 = RDS",
      "2 = VDI",
      "63 = AVD",
      "-1 = All"
    ],
    "sessionHostId": "text",
    "sessionHostName": "text",
    "poolName": "text",
    "user": "text",
    "ip": "text",
    "sessionState": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ]
  }
]