Sites | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve a Site.

Path parameters

idinteger · int32required

ID of the Site to be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Site/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:08:52.248Z",
  "timeLastMod": "2025-04-06T01:08:52.248Z",
  "name": "text",
  "licensingSite": true,
  "enableHttpHostAttackProtection": true
}

Success

Delete

delete

Delete a Site from the RAS farm.

Path parameters

idinteger · int32required

ID of the Site to be deleted

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Site/{id}'

204

401

404

No Content

List

get

Retrieve the list of all the available Sites.

Query parameters

Namestringoptional

Filter the result by name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Site'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:08:52.248Z",
    "timeLastMod": "2025-04-06T01:08:52.248Z",
    "name": "text",
    "licensingSite": true,
    "enableHttpHostAttackProtection": true
  }
]

Success

Create

post

Add a new site to the RAS farm.

Query parameters

noInstallbooleanoptional

If this parameter is included, the Connection Broker software will not be installed on the target server. You may use this option if the server already has the Connection Broker installed.

usernamestringoptional

A username to log in to the target server and push install the Connection Broker on it. You must also specify the Password parameter. If you've included the NoInstall parameter, you don't have to include the Username and Password parameters.

passwordstringoptional

The password for the user specified in the Username parameter.

noRestartbooleanoptional

Specifies not to add firewall rules to allow the RAS Agent to communicate. If this parameter is omitted, the firewall rules will not be added.

noFireWallRulesbooleanoptional

Specifies not to restart the server after the RAS agents are installed. If this parameter is omitted, the server will be restarted if required.

Body

Create a new Site

serverstring | nullablerequired

The target server FQDN or IP address.

namestring | nullableoptional

The name you want to use for the new site.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Site' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "server": "text",
    "name": "text"
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:08:52.248Z",
  "timeLastMod": "2025-04-06T01:08:52.248Z",
  "name": "text",
  "licensingSite": true,
  "enableHttpHostAttackProtection": true
}

Created

Update

put

Modify the Site properties.

Path parameters

idinteger · int32required

ID of the Site to be updated

Body

Update Site settings

namestring | nullableoptional

A new name to assign to the site.

enableHttpHostAttackProtectionboolean | nullableoptional

Whether Http Host Attack protection is enabled for this site or not.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Site/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "enableHttpHostAttackProtection": true
  }'

204

401

404

No Content