getAlarmDefinitions

v1.0.0

Get brief definitions of all the supported alarm types. The example field contains an example payload as you would recieve in the alarm webhook output.

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "key",
      "display",
      "group",
      "severity",
      "fields"
    ],
    "properties": {
      "display": {
        "type": "string",
        "description": "Description of the alarm type"
      },
      "fields": {
        "type": "array",
        "description": "List of fields available in an alarm details payload (in REST APIs & Webhooks); e.g. `aps`, `switches`, `gateways`, `hostnames`, `ssids`, `bssids`",
        "items": {
          "type": "string"
        }
      },
      "group": {
        "type": "string",
        "description": "Group to which the alarm belongs"
      },
      "key": {
        "type": "string",
        "description": "Key name of an alarm type"
      },
      "marvis_suggestion_category": {
        "type": "string",
        "description": "Marvis defined category to which the alarm belongs"
      },
      "severity": {
        "type": "string",
        "description": "Severity of the alarm"
      }
    }
  }
}