Notification Scripts

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
200

Success

application/json; api-version=1.0
get
/api/NotificationScripts

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
post
/api/NotificationScripts

Get

get

Retrieves a notification script by ID

Path parameters
idinteger · int32Required

Notification script ID

Responses
200

Success

application/json; api-version=1.0
get
/api/NotificationScripts/{id}

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
put
/api/NotificationScripts/{id}

No content

Delete

delete

Delete a script notification by ID.

Path parameters
idinteger · int32Required

Script notification ID

Responses
delete
/api/NotificationScripts/{id}

No content

Last updated