Process

List

get

Retrieve the list of all processes for all the VDI Host sessions.

Query parameters

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Provider server information (optional).

ServerstringOptional

The name of the Provider server for which to retrieve the information (optional).

Responses

200

Success

application/json; api-version=1.0

Information about applications running in Remote Session on a VDI Server

namestring · nullableOptional

Published Item name.

appNamestring · nullableOptional

Application name.

processstring · nullableOptional

Process name.

pidinteger · int32Optional

Process ID.

userstring · nullableOptional

User which is running the application.

sessioninteger · int32Optional

RAS session ID.

serverIDinteger · int32Optional

Server ID from where the application is hosted.

vdiHostIdstring · nullableOptional

Host VM ID

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Provider/VM/Host/Process

HTTPcURLJavaScriptPython

GET /api/Provider/VM/Host/Process HTTP/1.1
Accept: */*

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "pid": 1,
    "user": "text",
    "session": 1,
    "serverID": 1,
    "vdiHostId": "text"
  }
]

List by Provider ID

get

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

Path parameters

providerIdinteger · int32Required

The ID of the Provider server.

Responses

200

Success

application/json; api-version=1.0

Information about applications running in Remote Session on a VDI Server

namestring · nullableOptional

Published Item name.

appNamestring · nullableOptional

Application name.

processstring · nullableOptional

Process name.

pidinteger · int32Optional

Process ID.

userstring · nullableOptional

User which is running the application.

sessioninteger · int32Optional

RAS session ID.

serverIDinteger · int32Optional

Server ID from where the application is hosted.

vdiHostIdstring · nullableOptional

Host VM ID

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Provider/{providerId}/VM/Host/Process

HTTPcURLJavaScriptPython

GET /api/Provider/{providerId}/VM/Host/Process HTTP/1.1
Accept: */*

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "pid": 1,
    "user": "text",
    "session": 1,
    "serverID": 1,
    "vdiHostId": "text"
  }
]

List by Provider and VM ID

get

Retrieve the list of all processes for a specified VDI Host of a specified Provider.

Path parameters

providerIdinteger · int32Required

The ID of the Provider server.

vmIdstringRequired

VM ID.

Responses

200

Success

application/json; api-version=1.0

Information about applications running in Remote Session on a VDI Server

namestring · nullableOptional

Published Item name.

appNamestring · nullableOptional

Application name.

processstring · nullableOptional

Process name.

pidinteger · int32Optional

Process ID.

userstring · nullableOptional

User which is running the application.

sessioninteger · int32Optional

RAS session ID.

serverIDinteger · int32Optional

Server ID from where the application is hosted.

vdiHostIdstring · nullableOptional

Host VM ID

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Provider/{providerId}/VM/{vmId}/Host/Process

HTTPcURLJavaScriptPython

GET /api/Provider/{providerId}/VM/{vmId}/Host/Process HTTP/1.1
Accept: */*

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "pid": 1,
    "user": "text",
    "session": 1,
    "serverID": 1,
    "vdiHostId": "text"
  }
]

Get

get

Retrieve a specified process for a specified session of a specified Provider.

Path parameters

providerIdinteger · int32Required

The ID of the Provider server.

vmIdstringRequired

VM ID.

pIdinteger · int32Required

ID of the process to be retrieved

Responses

200

Success

application/json; api-version=1.0

Information about applications running in Remote Session on a VDI Server

namestring · nullableOptional

Published Item name.

appNamestring · nullableOptional

Application name.

processstring · nullableOptional

Process name.

pidinteger · int32Optional

Process ID.

userstring · nullableOptional

User which is running the application.

sessioninteger · int32Optional

RAS session ID.

serverIDinteger · int32Optional

Server ID from where the application is hosted.

vdiHostIdstring · nullableOptional

Host VM ID

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId}

HTTPcURLJavaScriptPython

GET /api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId} HTTP/1.1
Accept: */*

{
  "name": "text",
  "appName": "text",
  "process": "text",
  "pid": 1,
  "user": "text",
  "session": 1,
  "serverID": 1,
  "vdiHostId": "text"
}