Notification Scripts | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieves a notification script by ID

Path parameters

idinteger · int32required

Notification script ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:27:12.744Z",
  "timeLastMod": "2025-04-06T01:27:12.744Z",
  "name": "text",
  "siteId": 1,
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

Success

Delete

delete

Delete a script notification by ID.

Path parameters

idinteger · int32required

Script notification ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

204

401

404

No Content

List

get

Retrieves a list of notification script information

Query parameters

SiteIdinteger · int32optional

Site ID for which to retrieve notification scripts (optional)

Namestringoptional

Filter the result by notification name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:27:12.744Z",
    "timeLastMod": "2025-04-06T01:27:12.744Z",
    "name": "text",
    "siteId": 1,
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text"
  }
]

Success

Create

post

Creates a new notification script

Body

namestring | nullablerequired

Script name.

siteIdinteger · int32optional

Site ID If the parameter is omitted, the site ID of the Licensing Server will be used.

commandstring | nullablerequired

Command to execute when invoked.

argumentsstring | nullableoptional

Command arguments. Possible values: ($CA), ($ENROLLMENTMETHOD), ($FARM-NAME), ($HOSTPOOL), ($LOCATION), ($NOTIFICATION-TIME), ($NOTIFICATION-TYPE), ($PROVIDER), ($RESOURCEGROUP), ($SERVER-ADDRESS), ($SITE-NAME), ($TENANTBROKER), ($TENANTNAME), ($THRESHOLD-DIRECTION), ($THRESHOLD-VALUE), ($TRIGGER-ADDRESS), ($WORKSPACE)

initialDirectorystring | nullableoptional

Script base directory

usernamestring | nullableoptional

Execute script as this system user.

passwordstring | nullableoptional

System user password.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/NotificationScripts' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text",
    "password": "text"
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:27:12.744Z",
  "timeLastMod": "2025-04-06T01:27:12.744Z",
  "name": "text",
  "siteId": 1,
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

Created

Update

put

Update script notification by ID.

Path parameters

idinteger · int32required

Script notification ID

Body

namestring | nullableoptional

A new script name to assign.

commandstring | nullableoptional

Command to execute when invoked.

argumentsstring | nullableoptional

Command arguments.

initialDirectorystring | nullableoptional

Script base directory.

usernamestring | nullableoptional

Execute script as this system user.

passwordstring | nullableoptional

System user password.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/NotificationScripts/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text",
    "password": "text"
  }'

204

401

404

No Content