Parallels REST API

List

get

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

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).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/VM/Host/Process'

200

401

404

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

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/{providerId}/VM/Host/Process'

200

401

404

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

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/{providerId}/VM/{vmId}/Host/Process'

200

401

404

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

Success

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

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Provider/{providerId}/VM/{vmId}/Host/Process/{pId}'

200

401

404

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

Success

Kill

post

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

Path parameters

providerIdinteger · int32required

The ID of the provider.

vmIdstringrequired

VM ID.

idinteger · int32required

Process ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Provider/{providerId}/VM/{vmId}/Host/Process/{id}/Kill'

204

401

404

No body

No Content