1 of 4

Notifications

Events

Resources

Notification Scripts

Events

List

Retrieves all notification events configurations

GET/api/Notifications/Events

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notification events (optional)

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

0 = Unknown,4096 = CPU,8192 = Memory,12288 = RDSH,16384 = Agent,20480 = VDI,24576 = PubItem,28672 = License,32768 = Authentication,36864 = Gateway,40960 = Disk,45056 = Tenant,1097729 = FailedTunneledSess,1097730 = FailedTunneledSessTenantBroker,17829888 = CPUEvent,17833984 = MemoryEvent,17838081 = RDSHConnectedSessionEvent,17838082 = RDSHDisconnectedSessionEvent,17862657 = TunneledSess,34615299 = RDSHConnectedSessionEventPerc,34615300 = RDSHDisconnectedSessionEventPerc,34660353 = AVDActiveSessionsUtilization,34660354 = AVDDisconnectedSessionsUtilization

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Create

A configuration of an event notification such as license activation, agent disconnect/connect etc

POST/api/Notifications/Events

Body

Creates notifications for events such as license activation, agent disconect/connect etc.

siteIdinteger (int32)

Site ID where notification event is setup. Current site ID is used if siteId is omitted.

gracePeriodinteger (int32)

Grace period after the notification was done (minutes).

enableGracePeriodboolean

Enable/Disable grace period.

recipientsnullable array of string

Recipients to notify of the event.

itemsstring

sendEmailboolean

Enable/Disable email notification.

scriptIdinteger (int32)

Script to execute which has this ID.

executeScriptboolean

intervalinteger (int32)

Invocation interval (minutes).

enableIntervalboolean

Enable/Disable notification intervals.

waitUntilRecoveredboolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target Ids.

itemsinteger (int32)

type*RASNotificationEventType (enum)

RAS Notification Event Type

16384 = Agent,20480 = VDI,24576 = PubItem,28672 = License,32768 = Authentication,45056 = Tenant,1097729 = FailedTunneledSess

Response

Created

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Get

Retrieves a notification event by ID

GET/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Notification event ID

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Update

Update event notification by ID.

PUT/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Event notification ID

Body

Set event notification

enablednullable boolean

Enable/Disable notification.

gracePeriodnullable integer (int32)

Notification grace period (minutes).

enableGracePeriodnullable boolean

Enable/Disable grace period.

recipientsnullable array of string

Notification recipients.

itemsstring

sendEmailnullable boolean

Enable/Disable email notification.

scriptIdnullable integer (int32)

Use script of given ID.

executeScriptnullable boolean

Enable/Disable notification scripts.

intervalnullable integer (int32)

Notification interval (minutes).

enableIntervalnullable boolean

Enable/Disable notification intervals.

waitUntilRecoverednullable boolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target IDs.

itemsinteger (int32)

Response

No Content

Request

Response

Delete

Delete an event notification by ID.

DELETE/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Event notification ID

Response

No Content

Request

Response

Notifications

List

Retrieves all notification configurations.

GET/api/Notifications

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notifications (optional)

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Get

Retrieves a notification configuration.

GET/api/Notifications/{id}

Path parameters

id*integer (int32)

Notification ID

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Delete

Delete a notification by ID.

DELETE/api/Notifications/{id}

Path parameters

id*integer (int32)

Notification ID

Response

No Content

Request

Response

Resources

List

Retrieves all resource notifications configurations.

GET/api/Notifications/Resources

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notifications (optional)

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

thresholdinteger (int32)

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Request

Response

Create

A configuration of a resource notification such as high/low RAM/CPU usage etc.

POST/api/Notifications/Resources

Body

Creates a resource notification such as high/low RAM/CPU usage etc.

siteIdinteger (int32)

Site ID where notification event is setup. Current site ID is used if siteId is omitted.

gracePeriodinteger (int32)

Grace period after the notification was done (minutes).

enableGracePeriodboolean

Enable/Disable grace period.

recipientsnullable array of string

Recipients to notify of the event.

itemsstring

sendEmailboolean

Enable/Disable email notification.

scriptIdinteger (int32)

Script to execute which has this ID.

executeScriptboolean

intervalinteger (int32)

Invocation interval (minutes).

enableIntervalboolean

Enable/Disable notification intervals.

waitUntilRecoveredboolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target Ids.

itemsinteger (int32)

type*RASNotificationResourceType (enum)

RAS Notification Type

17829888 = CPUEvent,17833984 = MemoryEvent,17838081 = RDSHConnectedSessionEvent,17838082 = DisconnectSessionEvent,17862657 = TunneledSess,34615299 = RDSHConnectSessionEvent,34615300 = RDSHDisconnectSessionEvent

thresholdinteger (int32)

Tolerance value which triggers notification.

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Response

Created

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

thresholdinteger (int32)

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Request

Response

Get

Retrieve a specific resource notification by ID.

GET/api/Notifications/{id}/Resources

Path parameters

id*integer (int32)

Notification resource ID

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

thresholdinteger (int32)

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Request

Response

Update

Update resource notification by ID.

PUT/api/Notifications/{id}/Resources

Path parameters

id*integer (int32)

Resource notification ID

Body

Set resource notification

enablednullable boolean

Enable/Disable notification.

gracePeriodnullable integer (int32)

Notification grace period (minutes).

enableGracePeriodnullable boolean

Enable/Disable grace period.

recipientsnullable array of string

Notification recipients.

itemsstring

sendEmailnullable boolean

Enable/Disable email notification.

scriptIdnullable integer (int32)

Use script of given ID.

executeScriptnullable boolean

Enable/Disable notification scripts.

intervalnullable integer (int32)

Notification interval (minutes).

enableIntervalnullable boolean

Enable/Disable notification intervals.

waitUntilRecoverednullable boolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target IDs.

itemsinteger (int32)

thresholdnullable integer (int32)

Tolerance value which triggers notification.

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Response

No Content

Request

Response

Delete

Delete a resource notification by ID.

DELETE/api/Notifications/{id}/Resources

Path parameters

id*integer (int32)

Resource notification ID

Response

No Content

Request

Response

Delete

Delete an event notification by ID.

DELETE/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Event notification ID

Response

No Content

Request

Response

Delete

Delete a notification by ID.

DELETE/api/Notifications/{id}

Path parameters

id*integer (int32)

Notification ID

Response

No Content

Request

Response

Delete

Delete a resource notification by ID.

DELETE/api/Notifications/{id}/Resources

Path parameters

id*integer (int32)

Resource notification ID

Response

No Content

Request

Response

List

Retrieves all notification events configurations

GET/api/Notifications/Events

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notification events (optional)

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Get

Retrieves a notification configuration.

GET/api/Notifications/{id}

Path parameters

id*integer (int32)

Notification ID

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Get

Retrieves a notification event by ID

GET/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Notification event ID

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

List

Retrieves all resource notifications configurations.

GET/api/Notifications/Resources

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notifications (optional)

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

thresholdinteger (int32)

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Request

Response

Update

Update event notification by ID.

PUT/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Event notification ID

Body

Set event notification

enablednullable boolean

Enable/Disable notification.

gracePeriodnullable integer (int32)

Notification grace period (minutes).

enableGracePeriodnullable boolean

Enable/Disable grace period.

recipientsnullable array of string

Notification recipients.

itemsstring

sendEmailnullable boolean

Enable/Disable email notification.

scriptIdnullable integer (int32)

Use script of given ID.

executeScriptnullable boolean

Enable/Disable notification scripts.

intervalnullable integer (int32)

Notification interval (minutes).

enableIntervalnullable boolean

Enable/Disable notification intervals.

waitUntilRecoverednullable boolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target IDs.

itemsinteger (int32)

Response

No Content

Request

Response

List

Retrieves all notification configurations.

GET/api/Notifications

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notifications (optional)

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Get

Retrieve a specific resource notification by ID.

GET/api/Notifications/{id}/Resources

Path parameters

id*integer (int32)

Notification resource ID

Response

Success

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

thresholdinteger (int32)

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Request

Response

Update

Update resource notification by ID.

PUT/api/Notifications/{id}/Resources

Path parameters

id*integer (int32)

Resource notification ID

Body

Set resource notification

enablednullable boolean

Enable/Disable notification.

gracePeriodnullable integer (int32)

Notification grace period (minutes).

enableGracePeriodnullable boolean

Enable/Disable grace period.

recipientsnullable array of string

Notification recipients.

itemsstring

sendEmailnullable boolean

Enable/Disable email notification.

scriptIdnullable integer (int32)

Use script of given ID.

executeScriptnullable boolean

Enable/Disable notification scripts.

intervalnullable integer (int32)

Notification interval (minutes).

enableIntervalnullable boolean

Enable/Disable notification intervals.

waitUntilRecoverednullable boolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target IDs.

itemsinteger (int32)

thresholdnullable integer (int32)

Tolerance value which triggers notification.

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Response

No Content

Request

Response

Create

A configuration of an event notification such as license activation, agent disconnect/connect etc

POST/api/Notifications/Events

Body

Creates notifications for events such as license activation, agent disconect/connect etc.

siteIdinteger (int32)

Site ID where notification event is setup. Current site ID is used if siteId is omitted.

gracePeriodinteger (int32)

Grace period after the notification was done (minutes).

enableGracePeriodboolean

Enable/Disable grace period.

recipientsnullable array of string

Recipients to notify of the event.

itemsstring

sendEmailboolean

Enable/Disable email notification.

scriptIdinteger (int32)

Script to execute which has this ID.

executeScriptboolean

intervalinteger (int32)

Invocation interval (minutes).

enableIntervalboolean

Enable/Disable notification intervals.

waitUntilRecoveredboolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target Ids.

itemsinteger (int32)

type*RASNotificationEventType (enum)

RAS Notification Event Type

16384 = Agent,20480 = VDI,24576 = PubItem,28672 = License,32768 = Authentication,45056 = Tenant,1097729 = FailedTunneledSess

Response

Created

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

Request

Response

Create

A configuration of a resource notification such as high/low RAM/CPU usage etc.

POST/api/Notifications/Resources

Body

Creates a resource notification such as high/low RAM/CPU usage etc.

siteIdinteger (int32)

Site ID where notification event is setup. Current site ID is used if siteId is omitted.

gracePeriodinteger (int32)

Grace period after the notification was done (minutes).

enableGracePeriodboolean

Enable/Disable grace period.

recipientsnullable array of string

Recipients to notify of the event.

itemsstring

sendEmailboolean

Enable/Disable email notification.

scriptIdinteger (int32)

Script to execute which has this ID.

executeScriptboolean

intervalinteger (int32)

Invocation interval (minutes).

enableIntervalboolean

Enable/Disable notification intervals.

waitUntilRecoveredboolean

Wait until recovered.

allServersnullable boolean

All servers in site.

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

Target Ids.

itemsinteger (int32)

type*RASNotificationResourceType (enum)

RAS Notification Type

thresholdinteger (int32)

Tolerance value which triggers notification.

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Response

Created

Body

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.

siteIdinteger (int32)

enabledboolean

hasThresholdboolean

typeNotificationType (enum)

Type of notification

recipientsnullable string

executeScriptboolean

scriptIdinteger (int32)

sendEmailboolean

gracePeriodinteger (int32)

enableGracePeriodboolean

intervalinteger (int32)

enableIntervalboolean

waitUntilRecoveredboolean

allServersboolean

targetTypeTargetType (enum)

Target Type

0 = AllServers,3 = Gateways,5 = RemotePCs,7 = PublishingAgents,10 = VDIHostPools,16 = RDSHGroups,46 = EnrollmentServers,65 = AVDHostPools,-1 = ForceAllAgents

targetIdsnullable array of integer (int32)

itemsinteger (int32)

thresholdinteger (int32)

directionThresholdDirection (enum)

Threshold direction

1 = RisesAbove,2 = LowersBelow

Request

Response

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

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

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

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

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:01:44.778Z",
    "timeLastMod": "2024-11-07T10:01:44.778Z",
    "enabled": false,
    "hasThreshold": false,
    "type": [
      "0 = Unknown",
      "4096 = CPU",
      "8192 = Memory",
      "12288 = RDSH",
      "16384 = Agent",
      "20480 = VDI",
      "24576 = PubItem",
      "28672 = License",
      "32768 = Authentication",
      "36864 = Gateway",
      "40960 = Disk",
      "45056 = Tenant",
      "1097729 = FailedTunneledSess",
      "1097730 = FailedTunneledSessTenantBroker",
      "17829888 = CPUEvent",
      "17833984 = MemoryEvent",
      "17838081 = RDSHConnectedSessionEvent",
      "17838082 = RDSHDisconnectedSessionEvent",
      "17862657 = TunneledSess",
      "34615299 = RDSHConnectedSessionEventPerc",
      "34615300 = RDSHDisconnectedSessionEventPerc",
      "34660353 = AVDActiveSessionsUtilization",
      "34660354 = AVDDisconnectedSessionsUtilization"
    ],
    "recipients": "text",
    "executeScript": false,
    "sendEmail": false,
    "enableGracePeriod": false,
    "enableInterval": false,
    "waitUntilRecovered": false,
    "allServers": false,
    "targetType": [
      "0 = AllServers",
      "3 = Gateways",
      "5 = RemotePCs",
      "7 = PublishingAgents",
      "10 = VDIHostPools",
      "16 = RDSHGroups",
      "46 = EnrollmentServers",
      "65 = AVDHostPools",
      "-1 = ForceAllAgents"
    ],
    "targetIds": []
  }
]

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

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:44.778Z",
  "timeLastMod": "2024-11-07T10:01:44.778Z",
  "enabled": false,
  "hasThreshold": false,
  "type": [
    "0 = Unknown",
    "4096 = CPU",
    "8192 = Memory",
    "12288 = RDSH",
    "16384 = Agent",
    "20480 = VDI",
    "24576 = PubItem",
    "28672 = License",
    "32768 = Authentication",
    "36864 = Gateway",
    "40960 = Disk",
    "45056 = Tenant",
    "1097729 = FailedTunneledSess",
    "1097730 = FailedTunneledSessTenantBroker",
    "17829888 = CPUEvent",
    "17833984 = MemoryEvent",
    "17838081 = RDSHConnectedSessionEvent",
    "17838082 = RDSHDisconnectedSessionEvent",
    "17862657 = TunneledSess",
    "34615299 = RDSHConnectedSessionEventPerc",
    "34615300 = RDSHDisconnectedSessionEventPerc",
    "34660353 = AVDActiveSessionsUtilization",
    "34660354 = AVDDisconnectedSessionsUtilization"
  ],
  "recipients": "text",
  "executeScript": false,
  "sendEmail": false,
  "enableGracePeriod": false,
  "enableInterval": false,
  "waitUntilRecovered": false,
  "allServers": false,
  "targetType": [
    "0 = AllServers",
    "3 = Gateways",
    "5 = RemotePCs",
    "7 = PublishingAgents",
    "10 = VDIHostPools",
    "16 = RDSHGroups",
    "46 = EnrollmentServers",
    "65 = AVDHostPools",
    "-1 = ForceAllAgents"
  ],
  "targetIds": []
}

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

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:44.778Z",
  "timeLastMod": "2024-11-07T10:01:44.778Z",
  "enabled": false,
  "hasThreshold": false,
  "type": [
    "0 = Unknown",
    "4096 = CPU",
    "8192 = Memory",
    "12288 = RDSH",
    "16384 = Agent",
    "20480 = VDI",
    "24576 = PubItem",
    "28672 = License",
    "32768 = Authentication",
    "36864 = Gateway",
    "40960 = Disk",
    "45056 = Tenant",
    "1097729 = FailedTunneledSess",
    "1097730 = FailedTunneledSessTenantBroker",
    "17829888 = CPUEvent",
    "17833984 = MemoryEvent",
    "17838081 = RDSHConnectedSessionEvent",
    "17838082 = RDSHDisconnectedSessionEvent",
    "17862657 = TunneledSess",
    "34615299 = RDSHConnectedSessionEventPerc",
    "34615300 = RDSHDisconnectedSessionEventPerc",
    "34660353 = AVDActiveSessionsUtilization",
    "34660354 = AVDDisconnectedSessionsUtilization"
  ],
  "recipients": "text",
  "executeScript": false,
  "sendEmail": false,
  "enableGracePeriod": false,
  "enableInterval": false,
  "waitUntilRecovered": false,
  "allServers": false,
  "targetType": [
    "0 = AllServers",
    "3 = Gateways",
    "5 = RemotePCs",
    "7 = PublishingAgents",
    "10 = VDIHostPools",
    "16 = RDSHGroups",
    "46 = EnrollmentServers",
    "65 = AVDHostPools",
    "-1 = ForceAllAgents"
  ],
  "targetIds": []
}

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

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:01:44.778Z",
    "timeLastMod": "2024-11-07T10:01:44.778Z",
    "enabled": false,
    "hasThreshold": false,
    "type": [
      "0 = Unknown",
      "4096 = CPU",
      "8192 = Memory",
      "12288 = RDSH",
      "16384 = Agent",
      "20480 = VDI",
      "24576 = PubItem",
      "28672 = License",
      "32768 = Authentication",
      "36864 = Gateway",
      "40960 = Disk",
      "45056 = Tenant",
      "1097729 = FailedTunneledSess",
      "1097730 = FailedTunneledSessTenantBroker",
      "17829888 = CPUEvent",
      "17833984 = MemoryEvent",
      "17838081 = RDSHConnectedSessionEvent",
      "17838082 = RDSHDisconnectedSessionEvent",
      "17862657 = TunneledSess",
      "34615299 = RDSHConnectedSessionEventPerc",
      "34615300 = RDSHDisconnectedSessionEventPerc",
      "34660353 = AVDActiveSessionsUtilization",
      "34660354 = AVDDisconnectedSessionsUtilization"
    ],
    "recipients": "text",
    "executeScript": false,
    "sendEmail": false,
    "enableGracePeriod": false,
    "enableInterval": false,
    "waitUntilRecovered": false,
    "allServers": false,
    "targetType": [
      "0 = AllServers",
      "3 = Gateways",
      "5 = RemotePCs",
      "7 = PublishingAgents",
      "10 = VDIHostPools",
      "16 = RDSHGroups",
      "46 = EnrollmentServers",
      "65 = AVDHostPools",
      "-1 = ForceAllAgents"
    ],
    "targetIds": [],
    "direction": [
      "1 = RisesAbove",
      "2 = LowersBelow"
    ]
  }
]

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

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

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:01:44.778Z",
    "timeLastMod": "2024-11-07T10:01:44.778Z",
    "enabled": false,
    "hasThreshold": false,
    "type": [
      "0 = Unknown",
      "4096 = CPU",
      "8192 = Memory",
      "12288 = RDSH",
      "16384 = Agent",
      "20480 = VDI",
      "24576 = PubItem",
      "28672 = License",
      "32768 = Authentication",
      "36864 = Gateway",
      "40960 = Disk",
      "45056 = Tenant",
      "1097729 = FailedTunneledSess",
      "1097730 = FailedTunneledSessTenantBroker",
      "17829888 = CPUEvent",
      "17833984 = MemoryEvent",
      "17838081 = RDSHConnectedSessionEvent",
      "17838082 = RDSHDisconnectedSessionEvent",
      "17862657 = TunneledSess",
      "34615299 = RDSHConnectedSessionEventPerc",
      "34615300 = RDSHDisconnectedSessionEventPerc",
      "34660353 = AVDActiveSessionsUtilization",
      "34660354 = AVDDisconnectedSessionsUtilization"
    ],
    "recipients": "text",
    "executeScript": false,
    "sendEmail": false,
    "enableGracePeriod": false,
    "enableInterval": false,
    "waitUntilRecovered": false,
    "allServers": false,
    "targetType": [
      "0 = AllServers",
      "3 = Gateways",
      "5 = RemotePCs",
      "7 = PublishingAgents",
      "10 = VDIHostPools",
      "16 = RDSHGroups",
      "46 = EnrollmentServers",
      "65 = AVDHostPools",
      "-1 = ForceAllAgents"
    ],
    "targetIds": []
  }
]

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

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:44.778Z",
  "timeLastMod": "2024-11-07T10:01:44.778Z",
  "enabled": false,
  "hasThreshold": false,
  "type": [
    "0 = Unknown",
    "4096 = CPU",
    "8192 = Memory",
    "12288 = RDSH",
    "16384 = Agent",
    "20480 = VDI",
    "24576 = PubItem",
    "28672 = License",
    "32768 = Authentication",
    "36864 = Gateway",
    "40960 = Disk",
    "45056 = Tenant",
    "1097729 = FailedTunneledSess",
    "1097730 = FailedTunneledSessTenantBroker",
    "17829888 = CPUEvent",
    "17833984 = MemoryEvent",
    "17838081 = RDSHConnectedSessionEvent",
    "17838082 = RDSHDisconnectedSessionEvent",
    "17862657 = TunneledSess",
    "34615299 = RDSHConnectedSessionEventPerc",
    "34615300 = RDSHDisconnectedSessionEventPerc",
    "34660353 = AVDActiveSessionsUtilization",
    "34660354 = AVDDisconnectedSessionsUtilization"
  ],
  "recipients": "text",
  "executeScript": false,
  "sendEmail": false,
  "enableGracePeriod": false,
  "enableInterval": false,
  "waitUntilRecovered": false,
  "allServers": false,
  "targetType": [
    "0 = AllServers",
    "3 = Gateways",
    "5 = RemotePCs",
    "7 = PublishingAgents",
    "10 = VDIHostPools",
    "16 = RDSHGroups",
    "46 = EnrollmentServers",
    "65 = AVDHostPools",
    "-1 = ForceAllAgents"
  ],
  "targetIds": [],
  "direction": [
    "1 = RisesAbove",
    "2 = LowersBelow"
  ]
}

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

const response = await fetch('/api/Notifications/Events', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "type": [
        "16384 = Agent",
        "20480 = VDI",
        "24576 = PubItem",
        "28672 = License",
        "32768 = Authentication",
        "45056 = Tenant",
        "1097729 = FailedTunneledSess"
      ]
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:44.778Z",
  "timeLastMod": "2024-11-07T10:01:44.778Z",
  "enabled": false,
  "hasThreshold": false,
  "type": [
    "0 = Unknown",
    "4096 = CPU",
    "8192 = Memory",
    "12288 = RDSH",
    "16384 = Agent",
    "20480 = VDI",
    "24576 = PubItem",
    "28672 = License",
    "32768 = Authentication",
    "36864 = Gateway",
    "40960 = Disk",
    "45056 = Tenant",
    "1097729 = FailedTunneledSess",
    "1097730 = FailedTunneledSessTenantBroker",
    "17829888 = CPUEvent",
    "17833984 = MemoryEvent",
    "17838081 = RDSHConnectedSessionEvent",
    "17838082 = RDSHDisconnectedSessionEvent",
    "17862657 = TunneledSess",
    "34615299 = RDSHConnectedSessionEventPerc",
    "34615300 = RDSHDisconnectedSessionEventPerc",
    "34660353 = AVDActiveSessionsUtilization",
    "34660354 = AVDDisconnectedSessionsUtilization"
  ],
  "recipients": "text",
  "executeScript": false,
  "sendEmail": false,
  "enableGracePeriod": false,
  "enableInterval": false,
  "waitUntilRecovered": false,
  "allServers": false,
  "targetType": [
    "0 = AllServers",
    "3 = Gateways",
    "5 = RemotePCs",
    "7 = PublishingAgents",
    "10 = VDIHostPools",
    "16 = RDSHGroups",
    "46 = EnrollmentServers",
    "65 = AVDHostPools",
    "-1 = ForceAllAgents"
  ],
  "targetIds": []
}

const response = await fetch('/api/Notifications/Resources', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "type": [
        "17829888 = CPUEvent",
        "17833984 = MemoryEvent",
        "17838081 = RDSHConnectedSessionEvent",
        "17838082 = DisconnectSessionEvent",
        "17862657 = TunneledSess",
        "34615299 = RDSHConnectSessionEvent",
        "34615300 = RDSHDisconnectSessionEvent"
      ]
    }),
});
const data = await response.json();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:44.778Z",
  "timeLastMod": "2024-11-07T10:01:44.778Z",
  "enabled": false,
  "hasThreshold": false,
  "type": [
    "0 = Unknown",
    "4096 = CPU",
    "8192 = Memory",
    "12288 = RDSH",
    "16384 = Agent",
    "20480 = VDI",
    "24576 = PubItem",
    "28672 = License",
    "32768 = Authentication",
    "36864 = Gateway",
    "40960 = Disk",
    "45056 = Tenant",
    "1097729 = FailedTunneledSess",
    "1097730 = FailedTunneledSessTenantBroker",
    "17829888 = CPUEvent",
    "17833984 = MemoryEvent",
    "17838081 = RDSHConnectedSessionEvent",
    "17838082 = RDSHDisconnectedSessionEvent",
    "17862657 = TunneledSess",
    "34615299 = RDSHConnectedSessionEventPerc",
    "34615300 = RDSHDisconnectedSessionEventPerc",
    "34660353 = AVDActiveSessionsUtilization",
    "34660354 = AVDDisconnectedSessionsUtilization"
  ],
  "recipients": "text",
  "executeScript": false,
  "sendEmail": false,
  "enableGracePeriod": false,
  "enableInterval": false,
  "waitUntilRecovered": false,
  "allServers": false,
  "targetType": [
    "0 = AllServers",
    "3 = Gateways",
    "5 = RemotePCs",
    "7 = PublishingAgents",
    "10 = VDIHostPools",
    "16 = RDSHGroups",
    "46 = EnrollmentServers",
    "65 = AVDHostPools",
    "-1 = ForceAllAgents"
  ],
  "targetIds": [],
  "direction": [
    "1 = RisesAbove",
    "2 = LowersBelow"
  ]
}

Notification Scripts

List

Retrieves a list of notification script information

GET/api/NotificationScripts

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notification scripts (optional)

Namestring

Filter the result by notification name (optional)

Response

Success

Body

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

Response

Create

Creates a new notification script

POST/api/NotificationScripts

Body

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

Created

Body

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

Response

Get

Retrieves a notification script by ID

GET/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Notification script ID

Response

Success

Body

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

Response

Update

Update script notification by ID.

PUT/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Body

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

No Content

Request

Response

Delete

Delete a script notification by ID.

DELETE/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Response

No Content

Request

Response

Delete

Delete a script notification by ID.

DELETE/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Response

No Content

Request

Response

Get

Retrieves a notification script by ID

GET/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Notification script ID

Response

Success

Body

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

Response

List

Retrieves a list of notification script information

GET/api/NotificationScripts

Query parameters

SiteIdinteger (int32)

Site ID for which to retrieve notification scripts (optional)

Namestring

Filter the result by notification name (optional)

Response

Success

Body

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

Response

Update

Update script notification by ID.

PUT/api/NotificationScripts/{id}

Path parameters

id*integer (int32)

Script notification ID

Body

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

No Content

Request

Response

Create

Creates a new notification script

POST/api/NotificationScripts

Body

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

initialDirectorynullable string

Script base directory

usernamenullable string

Execute script as this system user.

passwordnullable string

System user password.

Response

Created

Body

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

Response

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

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

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:45.952Z",
  "timeLastMod": "2024-11-07T10:01:45.952Z",
  "name": "text",
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}

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

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T10:01:45.952Z",
    "timeLastMod": "2024-11-07T10:01:45.952Z",
    "name": "text",
    "command": "text",
    "arguments": "text",
    "initialDirectory": "text",
    "username": "text"
  }
]

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();

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();

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T10:01:45.952Z",
  "timeLastMod": "2024-11-07T10:01:45.952Z",
  "name": "text",
  "command": "text",
  "arguments": "text",
  "initialDirectory": "text",
  "username": "text"
}