Server Attribute | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Delete

delete

Remove a Server Attribute for the specified published RD Session Host application.

Path parameters

idinteger · int32required

ID of the published RD Session Host application for which the Server Attribute will be deleted

serverIdinteger · int32required

ID of the RD Session Host Server for which the attribute will be deleted

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}'

204

401

404

No Content

Get

get

Retrieve Server Attributes for the specified published RD Session Host application.

Path parameters

idinteger · int32required

ID of the published RD Session Host application from which the Server Attribute will be shown

Query parameters

serverIdinteger · int32optional

ID of the RD Session Host Server from which attributes will be shown

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/{id}/Apps/RDS/ServerAttr'

200

401

404

[
  {
    "parameters": "text",
    "startIn": "text",
    "target": "text",
    "serverId": 1,
    "package": "text",
    "packagedApp": "text"
  }
]

Success

Create

post

Add a Server Attribute for the specified published RD Session Host application.

Path parameters

idinteger · int32required

ID of the published RD Session Host application for which the Server Attribute will be added

serverIdinteger · int32required

ID of the RD Session Host Server to which the attribute will be added

Body

Add a server to the list of servers where the Publishing is being hosted

serverIDinteger · int32required

RDS server ID on which the attributes will be updated.

targetstring | nullableoptional

Application target file. (i.e. calc.exe, file.txt, etc.)

startInstring | nullableoptional

Application working directory.

parametersstring | nullableoptional

Application parameters.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "serverID": 1,
    "target": "text",
    "startIn": "text",
    "parameters": "text"
  }'

201

401

404

No Content

Created

Update

put

Add a Server Attribute for the specified published RD Session Host application.

Path parameters

idinteger · int32required

ID of the published RD Session Host application for which the Server Attribute will be updated

serverIdinteger · int32required

ID of the RD Session Host Server for which the attribute will be updated

Body

Update a list of individual servers the published application is published from

targetstring | nullableoptional

Application target file. (i.e. calc.exe, file.txt, etc.)

startInstring | nullableoptional

Application working directory.

parametersstring | nullableoptional

Application parameters.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/PubItems/{id}/Apps/RDS/ServerAttr/{serverId}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "target": "text",
    "startIn": "text",
    "parameters": "text"
  }'

204

401

404

No Content