Kill

Kill Process

Invoke the RD Session Host to send the kill command to a process with the specified ID.

POST/api/RDS/Host/{rdsId}/sessions/processes/{id}/kill

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

RD Session Host Process ID of the RD Session Host Process to be killed.

Response

No Content

Request

Response

Processes

List

Retrieve the list of all processes for all the RD Session Host sessions.

GET/api/RDS/Host/sessions/processes

Query parameters

SiteIdinteger (int32)

Site ID for which processes for all the RD Session Host sessions will be retrieved (optional)

Serverstring

Filter the result by server name (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.

Request

Response

List by Server ID

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

GET/api/RDS/Host/{id}/sessions/processes

Path parameters

id*integer (int32)

Server ID for which processes for all the RD Session Host sessions will 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.

Request

Response

List by Server ID and Session ID

Retrieve the list of all processes for a specified session of a specified RDS.

GET/api/RDS/Host/{id}/sessions/{sessionId}/processes

Path parameters

id*integer (int32)

Server ID for which processes of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which all processes will 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.

Request

Response

Get

Retrieve a process with a specified PID for a specified session of a specified RD Session Host.

GET/api/RDS/Host/{id}/sessions/{sessionId}/processes/{pid}

Path parameters

id*integer (int32)

Server ID for which a process of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which a specified process will be retrieved

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.

Request

Response

Kill Process

Invoke the RD Session Host to send the kill command to a process with the specified ID.

POST/api/RDS/Host/{rdsId}/sessions/processes/{id}/kill

Path parameters

rdsId*integer (int32)

The ID of a RD Session Host server.

id*integer (int32)

RD Session Host Process ID of the RD Session Host Process to be killed.

Response

No Content

Request

Response

List by Server ID and Session ID

Retrieve the list of all processes for a specified session of a specified RDS.

GET/api/RDS/Host/{id}/sessions/{sessionId}/processes

Path parameters

id*integer (int32)

Server ID for which processes of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which all processes will 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.

Request

Response

Get

Retrieve a process with a specified PID for a specified session of a specified RD Session Host.

GET/api/RDS/Host/{id}/sessions/{sessionId}/processes/{pid}

Path parameters

id*integer (int32)

Server ID for which a process of a specified RD Session Host session will be retrieved

sessionId*integer (int32)

Session ID for which a specified process will be retrieved

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.

Request

Response

List

Retrieve the list of all processes for all the RD Session Host sessions.

GET/api/RDS/Host/sessions/processes

Query parameters

SiteIdinteger (int32)

Site ID for which processes for all the RD Session Host sessions will be retrieved (optional)

Serverstring

Filter the result by server name (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.

Request

Response

List by Server ID

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

GET/api/RDS/Host/{id}/sessions/processes

Path parameters

id*integer (int32)

Server ID for which processes for all the RD Session Host sessions will 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.

Request

Response

const response = await fetch('/api/RDS/Host/{rdsId}/sessions/processes/{id}/kill', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

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

const response = await fetch('/api/RDS/Host/{id}/sessions/{sessionId}/processes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

const response = await fetch('/api/RDS/Host/{id}/sessions/{sessionId}/processes/{pid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

const response = await fetch('/api/RDS/Host/sessions/processes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

const response = await fetch('/api/RDS/Host/{id}/sessions/processes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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