Events | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Get

get

Retrieves a notification event by ID

Path parameters

idinteger · int32Required

Notification event ID

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Notifications/{id}/Events HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:35:41.739Z",
  "timeLastMod": "2025-05-23T11:35:41.739Z",
  "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
  ]
}

Delete

delete

Delete an event notification by ID.

Path parameters

idinteger · int32Required

Event notification ID

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/Notifications/{id}/Events HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieves all notification events configurations

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve notification events (optional)

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Notifications/Events HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-23T11:35:41.739Z",
    "timeLastMod": "2025-05-23T11:35:41.739Z",
    "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
    ]
  }
]

Create

post

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

Body

siteIdinteger · int32Optional

Site ID where notification event is setup. Current site ID is used if siteId is omitted.

gracePeriodinteger · int32Optional

Grace period after the notification was done (minutes).

enableGracePeriodbooleanOptional

Enable/Disable grace period.

recipientsstring[] | nullableOptional

Recipients to notify of the event.

sendEmailbooleanOptional

Enable/Disable email notification.

scriptIdinteger · int32Optional

Script to execute which has this ID.

executeScriptbooleanOptionalDefault: false

intervalinteger · int32Optional

Invocation interval (minutes).

enableIntervalbooleanOptional

Enable/Disable notification intervals.

Default: false

waitUntilRecoveredbooleanOptional

Wait until recovered.

Default: false

allServersboolean | nullableOptional

All servers in site.

targetTypestring · enumOptional

Target Type

Possible values:

targetIdsinteger · int32[] | nullableOptional

Target Ids.

typestring · enumRequired

RAS Notification Event Type

Possible values:

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/Notifications/Events HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 563

{
  "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"
  ]
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:35:41.739Z",
  "timeLastMod": "2025-05-23T11:35:41.739Z",
  "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
  ]
}

Update

put

Update event notification by ID.

Path parameters

idinteger · int32Required

Event notification ID

Body

enabledboolean | nullableOptional

Enable/Disable notification.

gracePeriodinteger · int32 | nullableOptional

Notification grace period (minutes).

enableGracePeriodboolean | nullableOptional

Enable/Disable grace period.

recipientsstring[] | nullableOptional

Notification recipients.

sendEmailboolean | nullableOptional

Enable/Disable email notification.

scriptIdinteger · int32 | nullableOptional

Use script of given ID.

executeScriptboolean | nullableOptional

Enable/Disable notification scripts.

intervalinteger · int32 | nullableOptional

Notification interval (minutes).

enableIntervalboolean | nullableOptional

Enable/Disable notification intervals.

waitUntilRecoveredboolean | nullableOptional

Wait until recovered.

allServersboolean | nullableOptional

All servers in site.

targetTypestring · enumOptional

Target Type

Possible values:

targetIdsinteger · int32[] | nullableOptional

Target IDs.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/Notifications/{id}/Events HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 416

{
  "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
  ]
}

No content