Process

List

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

GET/api/Provider/VM/Host/Process

Query parameters

SiteIdinteger (int32)

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

Serverstring

The name of the Provider server for which to retrieve the information (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.

vdiHostIdnullable string

Host VM ID

Request

Response

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

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.

vdiHostIdnullable string

Host VM ID

Request

Response

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

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.

vdiHostIdnullable string

Host VM ID

Request

Response

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

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.

vdiHostIdnullable string

Host VM ID

Request

Response

Kill

Invoke the VDI Process Command to send the Kill command to the Process with specified Process ID.

POST/api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill

Path parameters

providerId*integer (int32)

The ID of the provider.

vmId*string

VM ID.

id*integer (int32)

Process ID.

Response

No Content

Request

Response

Kill

Invoke the VDI Process Command to send the Kill command to the Process with specified Process ID.

POST/api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill

Path parameters

providerId*integer (int32)

The ID of the provider.

vmId*string

VM ID.

id*integer (int32)

Process ID.

Response

No Content

Request

Response

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

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.

vdiHostIdnullable string

Host VM ID

Request

Response

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

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.

vdiHostIdnullable string

Host VM ID

Request

Response

List

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

GET/api/Provider/VM/Host/Process

Query parameters

SiteIdinteger (int32)

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

Serverstring

The name of the Provider server for which to retrieve the information (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.

vdiHostIdnullable string

Host VM ID

Request

Response

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

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.

vdiHostIdnullable string

Host VM ID

Request

Response

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

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

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

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "user": "text",
    "vdiHostId": "text"
  }
]

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

{
  "name": "text",
  "appName": "text",
  "process": "text",
  "user": "text",
  "vdiHostId": "text"
}

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

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "user": "text",
    "vdiHostId": "text"
  }
]

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

[
  {
    "name": "text",
    "appName": "text",
    "process": "text",
    "user": "text",
    "vdiHostId": "text"
  }
]