Events

PreviousNotifications NextResources

Last updated 12 months ago

Was this helpful?

List

Retrieves all notification events configurations

get

/api/Notifications/Events

Query parameters

SiteIdinteger · int32

Site ID for which to retrieve notification events (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Notifications/Events'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-03-17T08:04:22.395Z",
    "timeLastMod": "2025-03-17T08:04:22.395Z",
    "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
    ]
  }
]

Success

Create

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

post

/api/Notifications/Events

Body

siteIdinteger · int32

<para type="description">Site ID where notification event is setup.</para> <para type="description">Current site ID is used if siteId is omitted.</para>

gracePeriodinteger · int32

<para type="description">Grace period after the notification was done (minutes).</para>

enableGracePeriodboolean

<para type="description">Enable/Disable grace period.</para>

recipientsstring[] | nullable

<para type="description">Recipients to notify of the event.</para>

sendEmailboolean

<para type="description">Enable/Disable email notification.</para>

scriptIdinteger · int32

<para type="description">Script to execute which has this ID.</para>

executeScriptboolean · default: false

intervalinteger · int32

<para type="description">Invocation interval (minutes).</para>

enableIntervalboolean · default: false

<para type="description">Enable/Disable notification intervals.</para>

waitUntilRecoveredboolean · default: false

<para type="description">Wait until recovered.</para>

allServersboolean | nullable

<para type="description">All servers in site.</para>

targetTypestring · enum

<para type="synopsis">Target Type</para> <para type="description"></para>

Options:

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

targetIdsinteger · int32[] | nullable

<para type="description">Target Ids.</para>

typestring · enumrequired

<para type="synopsis">RAS Notification Event Type</para> <para type="description"></para>

Options:

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Notifications/Events' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "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": [
      "16384 = Agent",
      "20480 = VDI",
      "24576 = PubItem",
      "28672 = License",
      "32768 = Authentication",
      "45056 = Tenant",
      "1097729 = FailedTunneledSess"
    ]
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-17T08:04:22.395Z",
  "timeLastMod": "2025-03-17T08:04:22.395Z",
  "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
  ]
}

Created

Get

Retrieves a notification event by ID

get

/api/Notifications/{id}/Events

Path parameters

idinteger · int32required

Notification event ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Notifications/{id}/Events'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-17T08:04:22.395Z",
  "timeLastMod": "2025-03-17T08:04:22.395Z",
  "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
  ]
}

Success

Update

Update event notification by ID.

put

/api/Notifications/{id}/Events

Path parameters

idinteger · int32required

Event notification ID

Body

enabledboolean | nullable

<para type="description">Enable/Disable notification.</para>

gracePeriodinteger · int32 | nullable

<para type="description">Notification grace period (minutes).</para>

enableGracePeriodboolean | nullable

<para type="description">Enable/Disable grace period.</para>

recipientsstring[] | nullable

<para type="description">Notification recipients.</para>

sendEmailboolean | nullable

<para type="description">Enable/Disable email notification.</para>

scriptIdinteger · int32 | nullable

<para type="description">Use script of given ID.</para>

executeScriptboolean | nullable

<para type="description">Enable/Disable notification scripts.</para>

intervalinteger · int32 | nullable

<para type="description">Notification interval (minutes).</para>

enableIntervalboolean | nullable

<para type="description">Enable/Disable notification intervals.</para>

waitUntilRecoveredboolean | nullable

<para type="description">Wait until recovered.</para>

allServersboolean | nullable

<para type="description">All servers in site.</para>

targetTypestring · enum

<para type="synopsis">Target Type</para> <para type="description"></para>

Options:

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

targetIdsinteger · int32[] | nullable

<para type="description">Target IDs.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Notifications/{id}/Events' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "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
    ]
  }'

204

401

404

No body

No Content

Delete

Delete an event notification by ID.

delete

/api/Notifications/{id}/Events

Path parameters

idinteger · int32required

Event notification ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Notifications/{id}/Events'

204

401

404

No body

No Content