Sign in

v1

latestOpenAPI 3.0.02026-08-04164892.0 KB
alerting settings

Get data alert settings

Retrieves the current settings for data alerts.

get/api/v1/data-alerts/settings

Response

The alerting settings have been successfully returned

tenantIdstring

These persisted alerting settings are only available for this tenant. Extracted from request JWT.

dataAlertsLimitsnumber

Represents the number of data alerts limit to be consumed by the user either as an owner or recipient

dataAlertsConsumednumber

Represents the number of data alerts consumed by the user either as an owner or recipient

enable-data-alertingboolean required

true if data-alerting feature is enabled for this tenant. Enabling this feature also requires that the license has this feature enabled.

data-alerting-license-status'enabled' | 'disabled'

Whether the license for the tenant has the data alerting feature enabled.

max-recipients-in-target-accessinteger

The maximum number of recipients that can be present in an alerting task in TARGET_ACCESS mode. New recipients cannot be added when this limit is exceeded

data-alerting-feature-operation-status'none' | 'enabling' | 'disabling'

This indicates that there is an ongoing operation to either disable or enable the data alerting feature. none means that no such operation is ongoing. enabling/disabling means that system is currently enabling/disabling the feature

data-alerting-feature-operation-status-changestring

UTC timestamp of the most recent change of data-alerting-feature-operation-status. If there has not been any such change, this is the timestamp of the initial creation of the record.

Example response

{
  "tenantId": "cgdsAumGmQ6l0Bi7CUKt9V8P_Y9GL0sC",
  "dataAlertsLimits": 50,
  "dataAlertsConsumed": 40,
  "enable-data-alerting": true,
  "max-recipients-in-target-access": 100,
  "data-alerting-feature-operation-status": "disabling",
  "data-alerting-feature-operation-status-change": "2020-09-02T13:44:33Z"
}