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

Notification Script

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

siteIdinteger · int32Optional

commandstring · nullableOptional

argumentsstring · nullableOptional

initialDirectorystring · nullableOptional

usernamestring · nullableOptional

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/NotificationScripts

HTTPcURLJavaScriptPython

GET /api/NotificationScripts HTTP/1.1
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2026-03-10T22:59:16.439Z",
    "timeLastMod": "2026-03-10T22:59:16.439Z",
    "name": "text",
    "siteId": 1,
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text"
  }
]

Create

post

Creates a new notification script

Body

application/json; api-version=1.0

namestring · min: 1 · max: 255 · nullableRequired

Script name.

siteIdinteger · int32Optional

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

commandstring · min: 1 · max: 255 · nullableRequired

Command to execute when invoked.

argumentsstring · min: 1 · max: 255 · 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 · min: 1 · max: 255 · nullableOptional

Script base directory

usernamestring · min: 1 · max: 255 · nullableOptional

Execute script as this system user.

passwordstring · nullableOptional

System user password.

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

/api/NotificationScripts

HTTPcURLJavaScriptPython

POST /api/NotificationScripts HTTP/1.1
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": "2026-03-10T22:59:16.439Z",
  "timeLastMod": "2026-03-10T22:59:16.439Z",
  "name": "text",
  "siteId": 1,
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

Get

get

Retrieves a notification script by ID

Path parameters

idinteger · int32Required

Notification script ID

Responses

200

Success

application/json; api-version=1.0

Notification Script

idinteger · int32Optional

ID of the object.

adminCreatestring · nullableOptional

User who created the object.

adminLastModstring · nullableOptional

User who last modified the object.

timeCreatestring · date-timeOptional

Time when the object was created.

timeLastModstring · date-timeOptional

Time when the object was last modified.

namestring · nullableOptional

siteIdinteger · int32Optional

commandstring · nullableOptional

argumentsstring · nullableOptional

initialDirectorystring · nullableOptional

usernamestring · nullableOptional

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/NotificationScripts/{id}

HTTPcURLJavaScriptPython

GET /api/NotificationScripts/{id} HTTP/1.1
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2026-03-10T22:59:16.439Z",
  "timeLastMod": "2026-03-10T22:59:16.439Z",
  "name": "text",
  "siteId": 1,
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

Update

put

Update script notification by ID.

Path parameters

idinteger · int32Required

Script notification ID

Body

application/json; api-version=1.0

namestring · min: 1 · max: 255 · nullableOptional

A new script name to assign.

commandstring · min: 1 · max: 255 · nullableOptional

Command to execute when invoked.

argumentsstring · min: 1 · max: 255 · nullableOptional

Command arguments.

initialDirectorystring · min: 1 · max: 255 · nullableOptional

Script base directory.

usernamestring · min: 1 · max: 255 · nullableOptional

Execute script as this system user.

passwordstring · nullableOptional

System user password.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/NotificationScripts/{id}

HTTPcURLJavaScriptPython

PUT /api/NotificationScripts/{id} HTTP/1.1
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

delete

Delete a script notification by ID.

Path parameters

idinteger · int32Required

Script notification ID

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

/api/NotificationScripts/{id}

HTTPcURLJavaScriptPython

DELETE /api/NotificationScripts/{id} HTTP/1.1
Accept: */*

No content