Skip to main content

AlertCollection Schema

Data structure for Alert Collection objects.

Item Type​

This is a collection (list) of Alert items.

Usage​

# Example: Working with AlertCollection
items = [
    {"id":1,"rule_name":"rule_name-value-1","severity":"severity-value-1","alert_type":"alert_type-value-1","alert_status":"alert_status-value-1"},
    {"id":2,"rule_name":"rule_name-value-2","severity":"severity-value-2","alert_type":"alert_type-value-2","alert_status":"alert_status-value-2"}
]

# Pass to an action that requires this collection type
resource.some_action(body=items)

JSON Example​

[
  {
    "id": 1,
    "rule_name": "rule_name-value-1",
    "severity": "severity-value-1",
    "alert_type": "alert_type-value-1",
    "alert_status": "alert_status-value-1"
  },
  {
    "id": 2,
    "rule_name": "rule_name-value-2",
    "severity": "severity-value-2",
    "alert_type": "alert_type-value-2",
    "alert_status": "alert_status-value-2"
  }
]