Notification Scripts
Retrieves a list of notification script information
Site ID for which to retrieve notification scripts (optional)
Filter the result by notification name (optional)
Success
Unauthorized
Not Found
GET /api/NotificationScripts HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-08-22T01:14:59.966Z",
"timeLastMod": "2025-08-22T01:14:59.966Z",
"name": "text",
"siteId": 1,
"command": "text",
"arguments": "text",
"initialDirectory": "text",
"username": "text"
}
]Creates a new notification script
Script name.
Site ID If the parameter is omitted, the site ID of the Licensing Server will be used.
Command to execute when invoked.
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)
Script base directory
Execute script as this system user.
System user password.
Created
Unauthorized
Conflict
POST /api/NotificationScripts HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 124
{
"name": "text",
"siteId": 1,
"command": "text",
"arguments": "text",
"initialDirectory": "text",
"username": "text",
"password": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-08-22T01:14:59.966Z",
"timeLastMod": "2025-08-22T01:14:59.966Z",
"name": "text",
"siteId": 1,
"command": "text",
"arguments": "text",
"initialDirectory": "text",
"username": "text"
}Retrieves a notification script by ID
Notification script ID
Success
Unauthorized
Not Found
GET /api/NotificationScripts/{id} HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-08-22T01:14:59.966Z",
"timeLastMod": "2025-08-22T01:14:59.966Z",
"name": "text",
"siteId": 1,
"command": "text",
"arguments": "text",
"initialDirectory": "text",
"username": "text"
}Update script notification by ID.
Script notification ID
A new script name to assign.
Command to execute when invoked.
Command arguments.
Script base directory.
Execute script as this system user.
System user password.
No Content
Unauthorized
Not Found
PUT /api/NotificationScripts/{id} HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 113
{
"name": "text",
"command": "text",
"arguments": "text",
"initialDirectory": "text",
"username": "text",
"password": "text"
}No content
Delete a script notification by ID.
Script notification ID
No Content
Unauthorized
Not Found
DELETE /api/NotificationScripts/{id} HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?