Notifications

List

Retrieves all notification configurations.

GET/api/Notifications

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', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T13:58:37.574Z",
    "timeLastMod": "2024-12-21T13:58:37.574Z",
    "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 configuration.

GET/api/Notifications/{id}

Path parameters

id*integer (int32)

Notification 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}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T13:58:37.574Z",
  "timeLastMod": "2024-12-21T13:58:37.574Z",
  "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
  ]
}

Delete

Delete a notification by ID.

DELETE/api/Notifications/{id}

Path parameters

id*integer (int32)

Notification ID

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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