Process

List

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

GET/api/Provider/VM/Host/Process

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

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.

vdiHostIdnullable string

Host VM ID

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/VM/Host/Process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

List by Provider ID

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

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

Path parameters

providerId*integer (int32)

The ID of the Provider server.

Response

200401404

Success

Body

application/json; api-version=1.0

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.

vdiHostIdnullable string

Host VM ID

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/Host/Process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

List by Provider and VM ID

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

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

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

Response

200401404

Success

Body

application/json; api-version=1.0

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.

vdiHostIdnullable string

Host VM ID

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{vmId}/Host/Process', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Get

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

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

Path parameters

providerId*integer (int32)

The ID of the Provider server.

vmId*string

VM ID.

pId*integer (int32)

ID of the process to be retrieved

Response

200401404

Success

Body

application/json; api-version=1.0

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.

vdiHostIdnullable string

Host VM ID

Request

JavaScriptCurlPython

const response = await fetch('/api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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