Partially updates alarm rules

Partially updates alarm rules
Stable

Request

Returns instance of alarm rules

Security

apiKey

Path

enterprise_idstringrequired

A UUID string identifying this enterprise.

alarm_idstringrequired

A UUID string identifying the alarm ruleset.

Bodyapplication/json

idstring, (uuid)

enterprisestring, (uuid)required

devicesArray of any, (string)

groupsArray of strings

namestringrequired

descriptionstring

metricstringrequired

conditionsobjectrequired

action_emailsArray of strings, (email)

actionsArray of strings

alert_channelsArray of strings

created_onstring, (date-time)

updated_onstring, (date-time)

is_activeboolean

realert_intervalintegerrequired

repeat_timesinteger

trigger_countinteger

daily_trigger_countinteger

cURL

curl -i -X PATCH \
  'https://develop-api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/alarmrules/{alarm_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
    "devices": [
      null
    ],
    "groups": [
      "string"
    ],
    "name": "string",
    "description": "string",
    "metric": "string",
    "conditions": {
      "value": 0.1,
      "unit": "string",
      "comparator": "string",
      "toggle_state": true
    },
    "action_emails": [
      "user@example.com"
    ],
    "actions": [
      "string"
    ],
    "alert_channels": [
      "string"
    ],
    "created_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "is_active": true,
    "realert_interval": 0,
    "repeat_times": 0,
    "trigger_count": 0,
    "daily_trigger_count": 0
  }'

Responses

successful operation

Bodyapplication/json

idstring, (uuid)

enterprisestring, (uuid)

devicesobject

groupsArray of strings

namestring