Resources
Retrieves all resource notifications configurations.
Site ID for which to retrieve notifications (optional)
GET /api/Notifications/Resources HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-06-30T21:21:31.503Z",
"timeLastMod": "2025-06-30T21:21:31.503Z",
"siteId": 1,
"enabled": true,
"hasThreshold": true,
"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": true,
"scriptId": 1,
"sendEmail": true,
"gracePeriod": 1,
"enableGracePeriod": true,
"interval": 1,
"enableInterval": true,
"waitUntilRecovered": true,
"allServers": true,
"targetType": [
"0 = AllServers",
"3 = Gateways",
"5 = RemotePCs",
"7 = PublishingAgents",
"10 = VDIHostPools",
"16 = RDSHGroups",
"46 = EnrollmentServers",
"65 = AVDHostPools",
"-1 = ForceAllAgents"
],
"targetIds": [
1
],
"threshold": 1,
"direction": [
"1 = RisesAbove",
"2 = LowersBelow"
]
}
]
A configuration of a resource notification such as high/low RAM/CPU usage etc.
Site ID where notification event is setup. Current site ID is used if siteId is omitted.
Grace period after the notification was done (minutes).
Enable/Disable grace period.
Recipients to notify of the event.
Enable/Disable email notification.
Script to execute which has this ID.
false
Invocation interval (minutes).
Enable/Disable notification intervals.
false
Wait until recovered.
false
All servers in site.
Target Type
Target Ids.
RAS Notification Type
Tolerance value which triggers notification.
Threshold direction
POST /api/Notifications/Resources HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 712
{
"siteId": 1,
"gracePeriod": 1,
"enableGracePeriod": true,
"recipients": [
"text"
],
"sendEmail": true,
"scriptId": 1,
"executeScript": false,
"interval": 1,
"enableInterval": false,
"waitUntilRecovered": false,
"allServers": true,
"targetType": [
"0 = AllServers",
"3 = Gateways",
"5 = RemotePCs",
"7 = PublishingAgents",
"10 = VDIHostPools",
"16 = RDSHGroups",
"46 = EnrollmentServers",
"65 = AVDHostPools",
"-1 = ForceAllAgents"
],
"targetIds": [
1
],
"type": [
"17829888 = CPUEvent",
"17833984 = MemoryEvent",
"17838081 = RDSHConnectedSessionEvent",
"17838082 = DisconnectSessionEvent",
"17862657 = TunneledSess",
"34615299 = RDSHConnectSessionEvent",
"34615300 = RDSHDisconnectSessionEvent"
],
"threshold": 1,
"direction": [
"1 = RisesAbove",
"2 = LowersBelow"
]
}
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-06-30T21:21:31.503Z",
"timeLastMod": "2025-06-30T21:21:31.503Z",
"siteId": 1,
"enabled": true,
"hasThreshold": true,
"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": true,
"scriptId": 1,
"sendEmail": true,
"gracePeriod": 1,
"enableGracePeriod": true,
"interval": 1,
"enableInterval": true,
"waitUntilRecovered": true,
"allServers": true,
"targetType": [
"0 = AllServers",
"3 = Gateways",
"5 = RemotePCs",
"7 = PublishingAgents",
"10 = VDIHostPools",
"16 = RDSHGroups",
"46 = EnrollmentServers",
"65 = AVDHostPools",
"-1 = ForceAllAgents"
],
"targetIds": [
1
],
"threshold": 1,
"direction": [
"1 = RisesAbove",
"2 = LowersBelow"
]
}
Retrieve a specific resource notification by ID.
Notification resource ID
GET /api/Notifications/{id}/Resources HTTP/1.1
Host:
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2025-06-30T21:21:31.503Z",
"timeLastMod": "2025-06-30T21:21:31.503Z",
"siteId": 1,
"enabled": true,
"hasThreshold": true,
"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": true,
"scriptId": 1,
"sendEmail": true,
"gracePeriod": 1,
"enableGracePeriod": true,
"interval": 1,
"enableInterval": true,
"waitUntilRecovered": true,
"allServers": true,
"targetType": [
"0 = AllServers",
"3 = Gateways",
"5 = RemotePCs",
"7 = PublishingAgents",
"10 = VDIHostPools",
"16 = RDSHGroups",
"46 = EnrollmentServers",
"65 = AVDHostPools",
"-1 = ForceAllAgents"
],
"targetIds": [
1
],
"threshold": 1,
"direction": [
"1 = RisesAbove",
"2 = LowersBelow"
]
}
Update resource notification by ID.
Resource notification ID
Enable/Disable notification.
Notification grace period (minutes).
Enable/Disable grace period.
Notification recipients.
Enable/Disable email notification.
Use script of given ID.
Enable/Disable notification scripts.
Notification interval (minutes).
Enable/Disable notification intervals.
Wait until recovered.
All servers in site.
Target Type
Target IDs.
Tolerance value which triggers notification.
Threshold direction
PUT /api/Notifications/{id}/Resources HTTP/1.1
Host:
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 479
{
"enabled": true,
"gracePeriod": 1,
"enableGracePeriod": true,
"recipients": [
"text"
],
"sendEmail": true,
"scriptId": 1,
"executeScript": true,
"interval": 1,
"enableInterval": true,
"waitUntilRecovered": true,
"allServers": true,
"targetType": [
"0 = AllServers",
"3 = Gateways",
"5 = RemotePCs",
"7 = PublishingAgents",
"10 = VDIHostPools",
"16 = RDSHGroups",
"46 = EnrollmentServers",
"65 = AVDHostPools",
"-1 = ForceAllAgents"
],
"targetIds": [
1
],
"threshold": 1,
"direction": [
"1 = RisesAbove",
"2 = LowersBelow"
]
}
No content
Delete a resource notification by ID.
Resource notification ID
DELETE /api/Notifications/{id}/Resources HTTP/1.1
Host:
Accept: */*
No content
Was this helpful?