Introduction

This section explains how to extract the definition of alarms generated from alerts in the Gear Studio platform, using the data extraction API. These alarms are generated when certain predefined alert conditions are met. When values return to normal, the alarms are automatically closed.

To query alarms, the alarm data type is used, whose documentation can be found here.

There are three mechanisms for obtaining alarm information:

Get data for a specific alert by its ID, as explained here.
Get information for all alerts associated with an endpoint, device, facility, or client. Documentation can be found here.
Get information for all alerts associated with an endpoint, device, facility, or client, incrementally. Documentation can be found here.

Introduction

To query alarms, the alarm data type is used, whose documentation can be found here.

There are three mechanisms for obtaining alarm information:

Get data for a specific alert by its ID, as explained here.
Get information for all alerts associated with an endpoint, device, facility, or client. Documentation can be found here.
Get information for all alerts associated with an endpoint, device, facility, or client, incrementally. Documentation can be found here.

Alarms

Introduction

On this page

Alarms

Introduction

On this page