List Alerts

Use the GET v1/alerts/inventory web service to retrieve a list of alerts.

URI

https://<hostname>/ws/v1/alerts/inventory

API Usage

There is no request payload for the GET ws/v1/alerts/inventory API. Use the alert fields and queries to select alerts.

Parameters

Name	Type	Description
cursor	string	Cursor to get the next page of alerts. Omit on initial call.
orderby	string	Return alerts ordered by the field given. The default is “name asc”
query	string	Use a query expression to target a specific list of alerts. The default is all alerts.
size	integer	Number of items to return. The maximum and default is 1000.

Successful Response

Upon success, the list of alerts is returned.

{
  "count": 1,
  "size": 1000,
  "list": [
    {
      "description": "Detects when the office cellular backup network goes offline",
      "enabled": true,
      "fire": {
        "parameters": {
          "reconnectWindowDuration": "1"
        }
      },
      "id": 146639,
      "name": "Office Backup Offline",
      "priority": "high",
      "reset": {},
      "scope": {
        "type": "Device",
        "value": "00000000-00000000-00000000-00000000"
      },
      "type": "Device Offline"
    }
  ]
}

Error Response

An error response returns the error_status and error_message fields in the payload.

{
  "error_status": 400,
  "error_message": "error message"
}