Helpdesk Email Settings | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieve the help desk email settings

Query parameters

siteIdinteger · int32optional

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "helpDeskEnabled": true,
  "helpDeskEmail": "text"
}

Success

Update

put

Modify Help Desk Email Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

siteIdinteger · int32optional

The Site Id To Retrieve the Help Desk Email Settings

Body

apLockbooleanoptional

siteIdinteger · int32optional

The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

helpdeskEnabledboolean | nullableoptional

Whether RAS Helpdesk is enabled.

helpdeskEmailstring | nullableoptional

RAS Helpdesk email.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/HelpdeskEmailSettings' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "apLock": true,
    "siteId": 1,
    "helpdeskEnabled": true,
    "helpdeskEmail": "text"
  }'

204

401

404

No Content