Status

List

get

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

Query parameters

Idinteger · int32Optional

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

SiteIdinteger · int32Optional

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

Sourcestring · enumOptional

RDP Session Type

Possible values:

SessionHostIdstringOptional

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

SessionHostNamestringOptional

The name of the server to filter the app status information (optional).

Statestring · enumOptional

Session State

Possible values:

UserstringOptional

User to filter the app status information(optional).

IPstringOptional

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

ThemeIdinteger · int32Optional

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

GroupIdinteger · int32Optional

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

Sessioninteger · int32Optional

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

Responses

200

Success

application/json; api-version=1.0

Status of Published Item

processstring · nullableOptional

Process name.

pidinteger · int32Optional

Process ID.

sessioninteger · int32Optional

RAS session ID.

idinteger · int32Optional

App/Desktop ID.

namestring · nullableOptional

App/Desktop name.

executablePathstring · nullableOptional

Executable application path.

sessionTypestring · enumOptional

Session Type

Possible values:

sourcestring · enumOptional

RDP Session Type

Possible values:

sessionHostIdstring · nullableOptional

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

sessionHostNamestring · nullableOptional

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

poolNamestring · nullableOptional

Group/Pool Name.

userstring · nullableOptional

User which is running the application/desktop.

parentProcessIDinteger · int32Optional

ID of the parent process of the published item.

vdiDesktopRuntimeIdinteger · int32Optional

VDI Desktop Runtime ID of the process.

ipstring · nullableOptional

Session server IP.

themeIDinteger · int32Optional

Theme ID.

sessionStatestring · enumOptional

Session State

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/status

HTTPcURLJavaScriptPython

GET /api/PubItems/status HTTP/1.1
Accept: */*

[
  {
    "process": "text",
    "pid": 1,
    "session": 1,
    "id": 1,
    "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",
    "parentProcessID": 1,
    "vdiDesktopRuntimeId": 1,
    "ip": "text",
    "themeID": 1,
    "sessionState": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ]
  }
]

Get

get

Retrieve the published item status information.

Path parameters

idinteger · int32Required

Pub Item ID

Responses

200

Success

application/json; api-version=1.0

Status of Published Item

processstring · nullableOptional

Process name.

pidinteger · int32Optional

Process ID.

sessioninteger · int32Optional

RAS session ID.

idinteger · int32Optional

App/Desktop ID.

namestring · nullableOptional

App/Desktop name.

executablePathstring · nullableOptional

Executable application path.

sessionTypestring · enumOptional

Session Type

Possible values:

sourcestring · enumOptional

RDP Session Type

Possible values:

sessionHostIdstring · nullableOptional

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

sessionHostNamestring · nullableOptional

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

poolNamestring · nullableOptional

Group/Pool Name.

userstring · nullableOptional

User which is running the application/desktop.

parentProcessIDinteger · int32Optional

ID of the parent process of the published item.

vdiDesktopRuntimeIdinteger · int32Optional

VDI Desktop Runtime ID of the process.

ipstring · nullableOptional

Session server IP.

themeIDinteger · int32Optional

Theme ID.

sessionStatestring · enumOptional

Session State

Possible values:

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/PubItems/{id}/status

HTTPcURLJavaScriptPython

GET /api/PubItems/{id}/status HTTP/1.1
Accept: */*

[
  {
    "process": "text",
    "pid": 1,
    "session": 1,
    "id": 1,
    "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",
    "parentProcessID": 1,
    "vdiDesktopRuntimeId": 1,
    "ip": "text",
    "themeID": 1,
    "sessionState": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ]
  }
]