Processes | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

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

Query parameters

SiteIdinteger · int32optional

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

Serverstringoptional

Filter the result by server name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDS/Host/sessions/processes'

200

401

404

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

Success

List by Server ID

get

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

Path parameters

idinteger · int32required

Server ID for which processes for all the RD Session Host sessions will be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDS/Host/{id}/sessions/processes'

200

401

404

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

Success

List by Server ID and Session ID

get

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

Path parameters

idinteger · int32required

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

sessionIdinteger · int32required

Session ID for which all processes will be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDS/Host/{id}/sessions/{sessionId}/processes'

200

401

404

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

Success

Get

get

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

Path parameters

idinteger · int32required

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

sessionIdinteger · int32required

Session ID for which a specified process will be retrieved

pidinteger · int32required

ID of the process to be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDS/Host/{id}/sessions/{sessionId}/processes/{pid}'

200

401

404

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

Success