Notification Scripts

List

Retrieves a list of notification script information

GET/api/NotificationScripts

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/NotificationScripts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T13:53:05.624Z",
    "timeLastMod": "2024-12-21T13:53:05.624Z",
    "name": "text",
    "siteId": 0,
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text"
  }
]

Create

Creates a new notification script

POST/api/NotificationScripts

Body

application/json; api-version=1.0

A script can be attached to any of the notifications.

name*nullable string

Script name.

siteIdinteger (int32)

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

command*nullable string

Command to execute when invoked.

argumentsnullable string

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)

initialDirectorynullable string

Script base directory

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

201401409

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/NotificationScripts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "command": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T13:53:05.624Z",
  "timeLastMod": "2024-12-21T13:53:05.624Z",
  "name": "text",
  "siteId": 0,
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

Get

Retrieves a notification script by ID

GET/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Notification script ID

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

siteIdinteger (int32)

commandnullable string

argumentsnullable string

initialDirectorynullable string

usernamenullable string

Request

JavaScriptCurlPython

const response = await fetch('/api/NotificationScripts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T13:53:05.624Z",
  "timeLastMod": "2024-12-21T13:53:05.624Z",
  "name": "text",
  "siteId": 0,
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

Update

Update script notification by ID.

PUT/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Body

application/json; api-version=1.0

Set script notification

namenullable string

A new script name to assign.

commandnullable string

Command to execute when invoked.

argumentsnullable string

Command arguments.

initialDirectorynullable string

Script base directory.

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/NotificationScripts/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Delete

Delete a script notification by ID.

DELETE/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/NotificationScripts/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}