Sign in

v1

latestOpenAPI 3.1.22026-08-0611530152.3 KB
Alarms

List alarms

Retrieve all alarms used for the instance

get/alarms

Response

Successful response

idinteger

Alarm ID

type'cpu' | 'memory' | 'disk' | 'disk_auto_resize' | 'netsplit' | 'server_unreachable' | 'notice'

Alarm type

enabledboolean

Whether alarm is enabled

value_thresholdinteger

Value threshold to trigger alarm

value_calculation'fixed' | 'percentage'

How to treat value threshold (for disk and disk_auto_resize alarms)

time_thresholdinteger

Duration in seconds the value_threshold should be active before triggering

allow_downtimeboolean

For disk_auto_resize alarms only. Whether the automatic resize may proceed even if it requires brief downtime.

recipientsinteger[]

Recipient IDs to receive notifications

Example response

[
  {
    "id": 7395,
    "type": "cpu",
    "enabled": true,
    "value_threshold": 90,
    "value_calculation": "fixed",
    "time_threshold": 600,
    "recipients": [
      1
    ]
  }
]