> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/site-settings/notifications/events.md).
# Events
## List
> Retrieves all notification events configurations
```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/Notifications/Events":{"get":{"tags":["2-Site settings/Notifications//Handlers"],"summary":"List","description":"Retrieves all notification events configurations","operationId":"598bcf4d-eb51-4326-930f-b1c15114e8a7","parameters":[{"name":"SiteId","in":"query","description":"Site ID for which to retrieve notification events (optional)","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NotificationEventCriteria"}}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NotificationEventCriteria":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the object.","format":"int32"},"adminCreate":{"type":"string","description":"User who created the object.","nullable":true},"adminLastMod":{"type":"string","description":"User who last modified the object.","nullable":true},"timeCreate":{"type":"string","description":"Time when the object was created.","format":"date-time"},"timeLastMod":{"type":"string","description":"Time when the object was last modified.","format":"date-time"},"siteId":{"type":"integer","format":"int32"},"enabled":{"type":"boolean"},"hasThreshold":{"type":"boolean"},"type":{"$ref":"#/components/schemas/NotificationType"},"recipients":{"type":"string","nullable":true},"executeScript":{"type":"boolean"},"scriptId":{"type":"integer","format":"int32"},"sendEmail":{"type":"boolean"},"gracePeriod":{"type":"integer","format":"int32"},"enableGracePeriod":{"type":"boolean"},"interval":{"type":"integer","format":"int32"},"enableInterval":{"type":"boolean"},"waitUntilRecovered":{"type":"boolean"},"allServers":{"type":"boolean"},"targetType":{"$ref":"#/components/schemas/TargetType"},"targetIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false,"description":"Notification Event Criteria\r\n"},"NotificationType":{"enum":[["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"]],"type":"string","description":"Type of notification\r\n","format":"int32"},"TargetType":{"enum":[["0 = AllServers","3 = SecureGateways","5 = RemotePCs","7 = Brokers","10 = VDIHostPools","16 = RDSHostPools","46 = EnrollmentServers","65 = AVDHostPools","-1 = ForceAllAgents"]],"type":"string","description":"Target Type\r\n","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```
## Create
> A configuration of an event notification such as license activation, agent disconnect/connect etc
```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/Notifications/Events":{"post":{"tags":["2-Site settings/Notifications//Handlers"],"summary":"Create","description":"A configuration of an event notification such as license activation, agent disconnect/connect etc","operationId":"48ca5795-9b5c-467e-8eef-71ebd9fc8a24","requestBody":{"description":"Creates notifications for events such as license activation, agent disconect/connect etc.","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NewNotificationEvent"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NotificationEventCriteria"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NewNotificationEvent":{"required":["type"],"type":"object","properties":{"siteId":{"type":"integer","description":"Site ID where notification event is setup.\r\nCurrent site ID is used if siteId is omitted.","format":"int32"},"gracePeriod":{"type":"integer","description":"Grace period after the notification was done (minutes).","format":"int32"},"enableGracePeriod":{"type":"boolean","description":"Enable/Disable grace period."},"recipients":{"type":"array","items":{"type":"string"},"description":"Recipients to notify of the event.","nullable":true},"sendEmail":{"type":"boolean","description":"Enable/Disable email notification."},"scriptId":{"type":"integer","description":"Script to execute which has this ID.","format":"int32"},"executeScript":{"type":"boolean","default":false},"interval":{"type":"integer","description":"Invocation interval (minutes).","format":"int32"},"enableInterval":{"type":"boolean","description":"Enable/Disable notification intervals.","default":false},"waitUntilRecovered":{"type":"boolean","description":"Wait until recovered.","default":false},"allServers":{"type":"boolean","description":"All servers in site.","nullable":true},"targetType":{"$ref":"#/components/schemas/TargetType"},"targetIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Target Ids.","nullable":true},"type":{"$ref":"#/components/schemas/RASNotificationEventType"}},"additionalProperties":false},"TargetType":{"enum":[["0 = AllServers","3 = SecureGateways","5 = RemotePCs","7 = Brokers","10 = VDIHostPools","16 = RDSHostPools","46 = EnrollmentServers","65 = AVDHostPools","-1 = ForceAllAgents"]],"type":"string","description":"Target Type\r\n","format":"int32"},"RASNotificationEventType":{"enum":[["16384 = Agent","20480 = VDI","24576 = PubItem","28672 = License","32768 = Authentication","45056 = Tenant","1097729 = FailedTunneledSess"]],"type":"string","description":"RAS Notification Event Type\r\n","format":"int32"},"NotificationEventCriteria":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the object.","format":"int32"},"adminCreate":{"type":"string","description":"User who created the object.","nullable":true},"adminLastMod":{"type":"string","description":"User who last modified the object.","nullable":true},"timeCreate":{"type":"string","description":"Time when the object was created.","format":"date-time"},"timeLastMod":{"type":"string","description":"Time when the object was last modified.","format":"date-time"},"siteId":{"type":"integer","format":"int32"},"enabled":{"type":"boolean"},"hasThreshold":{"type":"boolean"},"type":{"$ref":"#/components/schemas/NotificationType"},"recipients":{"type":"string","nullable":true},"executeScript":{"type":"boolean"},"scriptId":{"type":"integer","format":"int32"},"sendEmail":{"type":"boolean"},"gracePeriod":{"type":"integer","format":"int32"},"enableGracePeriod":{"type":"boolean"},"interval":{"type":"integer","format":"int32"},"enableInterval":{"type":"boolean"},"waitUntilRecovered":{"type":"boolean"},"allServers":{"type":"boolean"},"targetType":{"$ref":"#/components/schemas/TargetType"},"targetIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false,"description":"Notification Event Criteria\r\n"},"NotificationType":{"enum":[["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"]],"type":"string","description":"Type of notification\r\n","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```
## Get
> Retrieves a notification event by ID
```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/Notifications/{id}/Events":{"get":{"tags":["2-Site settings/Notifications//Handlers"],"summary":"Get","description":"Retrieves a notification event by ID","operationId":"b8878e39-51ed-4889-8b84-949b46bf10f8","parameters":[{"name":"id","in":"path","description":"Notification event ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NotificationEventCriteria"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NotificationEventCriteria":{"type":"object","properties":{"id":{"type":"integer","description":"ID of the object.","format":"int32"},"adminCreate":{"type":"string","description":"User who created the object.","nullable":true},"adminLastMod":{"type":"string","description":"User who last modified the object.","nullable":true},"timeCreate":{"type":"string","description":"Time when the object was created.","format":"date-time"},"timeLastMod":{"type":"string","description":"Time when the object was last modified.","format":"date-time"},"siteId":{"type":"integer","format":"int32"},"enabled":{"type":"boolean"},"hasThreshold":{"type":"boolean"},"type":{"$ref":"#/components/schemas/NotificationType"},"recipients":{"type":"string","nullable":true},"executeScript":{"type":"boolean"},"scriptId":{"type":"integer","format":"int32"},"sendEmail":{"type":"boolean"},"gracePeriod":{"type":"integer","format":"int32"},"enableGracePeriod":{"type":"boolean"},"interval":{"type":"integer","format":"int32"},"enableInterval":{"type":"boolean"},"waitUntilRecovered":{"type":"boolean"},"allServers":{"type":"boolean"},"targetType":{"$ref":"#/components/schemas/TargetType"},"targetIds":{"type":"array","items":{"type":"integer","format":"int32"},"nullable":true}},"additionalProperties":false,"description":"Notification Event Criteria\r\n"},"NotificationType":{"enum":[["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"]],"type":"string","description":"Type of notification\r\n","format":"int32"},"TargetType":{"enum":[["0 = AllServers","3 = SecureGateways","5 = RemotePCs","7 = Brokers","10 = VDIHostPools","16 = RDSHostPools","46 = EnrollmentServers","65 = AVDHostPools","-1 = ForceAllAgents"]],"type":"string","description":"Target Type\r\n","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```
## Update
> Update event notification by ID.
```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/Notifications/{id}/Events":{"put":{"tags":["2-Site settings/Notifications//Handlers"],"summary":"Update","description":"Update event notification by ID.","operationId":"910553b1-7156-4f46-8680-dacab6e921be","parameters":[{"name":"id","in":"path","description":"Event notification ID","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Set event notification","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetNotificationEvent"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetNotificationEvent":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable/Disable notification.","nullable":true},"gracePeriod":{"type":"integer","description":"Notification grace period (minutes).","format":"int32","nullable":true},"enableGracePeriod":{"type":"boolean","description":"Enable/Disable grace period.","nullable":true},"recipients":{"type":"array","items":{"type":"string"},"description":"Notification recipients.","nullable":true},"sendEmail":{"type":"boolean","description":"Enable/Disable email notification.","nullable":true},"scriptId":{"type":"integer","description":"Use script of given ID.","format":"int32","nullable":true},"executeScript":{"type":"boolean","description":"Enable/Disable notification scripts.","nullable":true},"interval":{"type":"integer","description":"Notification interval (minutes).","format":"int32","nullable":true},"enableInterval":{"type":"boolean","description":"Enable/Disable notification intervals.","nullable":true},"waitUntilRecovered":{"type":"boolean","description":"Wait until recovered.","nullable":true},"allServers":{"type":"boolean","description":"All servers in site.","nullable":true},"targetType":{"$ref":"#/components/schemas/TargetType"},"targetIds":{"type":"array","items":{"type":"integer","format":"int32"},"description":"Target IDs.","nullable":true}},"additionalProperties":false},"TargetType":{"enum":[["0 = AllServers","3 = SecureGateways","5 = RemotePCs","7 = Brokers","10 = VDIHostPools","16 = RDSHostPools","46 = EnrollmentServers","65 = AVDHostPools","-1 = ForceAllAgents"]],"type":"string","description":"Target Type\r\n","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```
## Delete
> Delete an event notification by ID.
```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/Notifications/{id}/Events":{"delete":{"tags":["2-Site settings/Notifications//Handlers"],"summary":"Delete","description":"Delete an event notification by ID.","operationId":"3b6ba7a2-e287-4f74-a483-3c7afef6eab0","parameters":[{"name":"id","in":"path","description":"Event notification ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.parallels.com/landing/ras-rest-api-guide/api-reference/site-settings/notifications/events.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.