Thresholds API - GET all thresholds

Lists all configured thresholds for plugins and custom events in your environment.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/v1/thresholds
  • SaaS https://{your-environment-id}.live.dexp.ae/api/v1/thresholds

Parameters

Parameter Type Description In Required
filter string

Filters thresholds by the source.

The filter element can hold these values. 		query optional

Possible values

Possible values for the filter element:

  • ALL
  • API
  • PLUGIN
  • REMOTE_PLUGIN
  • USER_INTERACTION
  • WEB_UI

Response format

The Threshold object

Parameters of a single plugin or custom event threshold.

Element Type Description
thresholdId string

The ID of the threshold.
threshold number

The value of the threshold.
alertCondition string

The condition for the threshold value check: above or below.
samples integer

The number of one-minute samples that form sliding evaluation window.
violatingSamples integer

How many one-minute samples within the evaluation window should violate the threshold to trigger an event.
dealertingSamples integer

How many one-minute samples within the evaluation window should go back to normal to close the event.
eventType string

The type of the event to trigger on the threshold violation.
eventName string

The name of the event to trigger on the threshold violation.
description string

A description of the event, triggered by a threshold violation.

You can use the following placeholders: {severity}: the actual metric value, {alert_condition}: above or below threshold condition, {threshold}: the threshold value,{violating_samples}: the number of samples, violating the threshold, {dimensions}: metric's dimension that violated the threshold.
enabled boolean

The threshold is enabled/disabled.
timeseriesId string

The case-sensitive ID of the metric evaluated by threshold.

You can use it to find the metric via the timeseries endpoint of the API.
filter string

The source of the threshold.

Example

In this example, the request queries for all thresholds whose source is plugins.

The API token is passed in the Authorization header.

The result is truncated to three thresholds.

Curl

curl -X GET \
  'https://mySampleEnv.live.dexp.ae/api/v1/thresholds?filter=PLUGIN' \
  -H 'Authorization: Api-Token abcdefjhij1234567890'

Request URL

https://mySampleEnv.live.dexp.ae/api/v1/thresholds?filter=PLUGIN

Response body

[
  {
    "thresholdId": "ruxit.perfmon.dotnetV4:%TimeInGC:time_in_gc_alert_high_generic",
    "threshold": 70,
    "alertCondition": "ABOVE",
    "samples": 5,
    "violatingSamples": 3,
    "eventType": "PERFORMANCE_EVENT",
    "eventName": "High GC time",
    "filter": "PLUGIN",
    "enabled": false,
    "dealertingSamples": 5,
    "description": "The .NET GC time of {severity} is {alert_condition} the threshold of {threshold}",
    "timeseriesId": "ruxit.perfmon.dotnetV4:%TimeInGC"
  },
  {
    "thresholdId": "ruxit.python.mysql:slow_queries_rate:slow_queries_rate_alert_high",
    "threshold": 10,
    "alertCondition": "ABOVE",
    "samples": 10,
    "violatingSamples": 3,
    "eventType": "PGI_MYSQL_SLOW_QUERIES_RATE_HIGH",
    "eventName": "High MySQL slow queries rate",
    "filter": "PLUGIN",
    "enabled": true,
    "dealertingSamples": 10,
    "description": "",
    "timeseriesId": "ruxit.python.mysql:slow_queries_rate"
  },
  {
    "thresholdId": "ruxit.python.rabbitmq:mem_usage:mem_usage_alert_high_generic",
    "threshold": 90,
    "alertCondition": "ABOVE",
    "samples": 5,
    "violatingSamples": 3,
    "eventType": "PERFORMANCE_EVENT",
    "eventName": "High RabbitMQ memory usage",
    "filter": "PLUGIN",
    "enabled": true,
    "dealertingSamples": 5,
    "description": "The RabbitMQ memory usage of {severity} is {alert_condition} the threshold of {threshold}",
    "timeseriesId": "ruxit.python.rabbitmq:mem_usage"
    }
]

Response code

200