Documentation is now available for the Fall 2020 Update release!

Alerts

Endpoints associated with alerts.

Leave Feedback

In this section

Acknowledge alert

The endpoint is used to acknowledge an alert.

Add resources to a schedule maintenance window

This endpoint is used to add resources to a scheduled maintenance window.

Alert status history

This endpoint retrieves an alert’s status history.

Attach incident to an alert

This endpoint is used to attach an incident to an alert.

Create alert correlation policy

This endpoint is used to create an alert correlation policy.

Create alert escalation policy

A predefined action to be taken when an alert is not acknowledged.

Create alert on a resource

Create a single alert on a resource.

Create alerts on resources

This endpoint is used to generate multiple alerts on resources.

Create first response policy

This endpoint is used to create First Response Policy.

Create one-time schedule

This endpoint is used to create a one-time schedule for the device, device group, and site.

Create recurring schedule – daily pattern

This endpoint is used to create a daily recurring schedule.

Create recurring schedule – monthly pattern

This endpoint is used to create a monthly recurring schedule.

Create recurring schedule – weekly pattern

This endpoint is used to create a weekly recurring schedule.

Create rosters

This endpoint is used to create partner-level or client-level rosters.

Delete alert correlation policy

This endpoint is used to delete an alert correlation policy.

Delete alert escalation policy

This endpoint is used to delete an alert escalation policy.

Delete first response policy

The endpoint to assign agent policy for resources.

Delete roster

This endpoint is used to delete a roster.

Delete scheduled maintenance window

This endpoint is used to delete a scheduled maintenance window.

Disable alert escalation policy

This endpoint is used to disable an alert escalation policy.

Enable alert escalation policy

This endpoint is used to enable an alert escalation policy.

Enable or disable alert correlation policy

This endpoint is used to enable, disable, and create an observed mode on an alert correlation policy.

Enable or disable first response policy

This endpoint is used to enable or disable the first response policy.

End scheduled maintenance window

This endpoint is used to end a scheduled maintenance window.

Get alert

This endpoint retrieves alert details.

Get alert comments

This endpoint is used to retrieve the comments on an alert.

Get alert correlation policies of a client

This endpoint is used to fetch alert correlation policies of a client.

Get alert correlation policy

This endpoint is used to retrieve the details of an alert correlation policy.

Get alert escalation policy

This endpoint is used to retrieve an alert escalation policy of an organization by its policy id.

Get alert escalation policy by ID

This endpoint is used to retrieve the alert escalation policy of an alert using the alertId.

Get alert types

This endpoint is used to retrieve the list of supported alert types.

Get alert view by view ID

This endpoint is used to retrieve an alert view of a user.

Get alert views

This endpoint is used to retrieve a list of alert views.

Get alerts by an alert ID

This endpoint is used to retrieve the details of an alert by alert ID.

Get alerts by an event ID

This endpoint is used to retrieve the details of an alert by event ID.

Get alerts by incident ID

This endpoint is used to retrieve the details of an alert attached to an incident.

Get first response policies of client

This endpoint is used to view details of the first response policy.

Get First Response Policy

This endpoint is used to view details of the First Response Policy.

Get OAuth2 access token with client credentials

This endpoint is used to generate an access token using client credentials.

Get resources of a schedule maintenance window

This endpoint is used to retrieve the list of devices (or device groups or sites) of a scheduled maintenance window.

Get roster

This endpoint is used to retrieve the details of a roster.

Get schedule maintenance window

This endpoint is used to retrieve the details of a scheduled maintenance window.

Get sub alert types

This endpoint is used to retrieve the sub-alert types.

Post alert action

This endpoint is used to post an action on an alert.

Recommend alert escalation policy

This endpoint is used to enable recommend mode for an alert escalation policy

Remove resources from a schedule maintenance window

This endpoint is used to remove resources from a scheduled maintenance window.

Resume scheduled maintenance window

This endpoint is used to activate a user.

Search alert escalation policies

This endpoint is used to fetch the alert escalation policies attached to an alert.

Search alert occurrences

This endpoint retrieves the occurrences of an alert based on the alert-triggered time.

Search alerts

This endpoint is used to search alerts.

Search rosters

This endpoint is used to fetch the rosters within an organization.

Search scheduled maintenance windows

This endpoint is used to retrieve the scheduled maintenance windows under a specific tenant.

Suspend schedule maintenance window

This endpoint is used to suspend a scheduled maintenance window.

Update a pending schedule maintenance window

This endpoint is used to update a pending schedule maintenance window.

Update alert correlation policy

This endpoint is used to update an alert correlation policy.

Update alert escalation policy

This endpoint is used to update an alert escalation policy.

Update First Response Policy

This endpoint is used to update the First Response Policy.

Update incident by an alert ID

This endpoint is used to attach and update an incident to an alert.

Update roster

This endpoint is used to update the details of a roster.