Events

List

Retrieves all notification events configurations

GET/api/Notifications/Events

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.

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)

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T13:55:19.941Z",
    "timeLastMod": "2024-12-21T13:55:19.941Z",
    "siteId": 0,
    "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,
    "scriptId": 0,
    "sendEmail": false,
    "gracePeriod": 0,
    "enableGracePeriod": false,
    "interval": 0,
    "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": [
      0
    ]
  }
]

Create

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

POST/api/Notifications/Events

Body

application/json; api-version=1.0

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.

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.

type*RASNotificationEventType (enum)

RAS Notification Event Type

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

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.

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)

Request

JavaScriptCurlPython

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

Response

201401409

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T13:55:19.941Z",
  "timeLastMod": "2024-12-21T13:55:19.941Z",
  "siteId": 0,
  "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,
  "scriptId": 0,
  "sendEmail": false,
  "gracePeriod": 0,
  "enableGracePeriod": false,
  "interval": 0,
  "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": [
    0
  ]
}

Get

Retrieves a notification event by ID

GET/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Notification event 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.

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)

Request

JavaScriptCurlPython

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

Response

200401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T13:55:19.941Z",
  "timeLastMod": "2024-12-21T13:55:19.941Z",
  "siteId": 0,
  "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,
  "scriptId": 0,
  "sendEmail": false,
  "gracePeriod": 0,
  "enableGracePeriod": false,
  "interval": 0,
  "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": [
    0
  ]
}

Update

Update event notification by ID.

PUT/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Event notification ID

Body

application/json; api-version=1.0

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.

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.

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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

Delete

Delete an event notification by ID.

DELETE/api/Notifications/{id}/Events

Path parameters

id*integer (int32)

Event notification ID

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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