CLcloudamqp
Alarms

Update alarm

Update a specific alarm

put/alarms/{id}

Request

  • Base URL
    https://api.cloudamqp.com/api
  • URL
    https://api.cloudamqp.com/api/alarms/{id}
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

enabledboolean required

Enable or disable the alarm

value_thresholdinteger

Value threshold to trigger the alarm (required for cpu, memory, disk, disk_auto_resize)

value_calculation'fixed' | 'percentage'

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

time_thresholdinteger

Duration in seconds (required for cpu, memory, disk, disk_auto_resize)

allow_downtimeboolean

For disk_auto_resize alarms only. Allow the automatic resize to proceed even if it requires brief downtime. Defaults to false.

recipientsinteger[]

Recipient IDs to receive notifications

Response

Alarm updated successfully

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
  ]
}

Changes

No recorded changes to this operation across all 8 revisions of this API.