SolarWinds · Schema

SolarWinds Alert

Schema for a SolarWinds monitoring alert triggered by threshold violations or status changes on monitored entities.

Application MonitoringDatabase MonitoringInfrastructureIP Address ManagementIT ManagementITSMLog ManagementNetwork MonitoringObservability

Properties

Name Type Description
alertId integer Unique identifier for the alert instance
alertName string Display name of the alert definition
severity string Alert severity level
triggeredAt string Timestamp when the alert was triggered
resetAt stringnull Timestamp when the alert was reset, null if still active
acknowledged boolean Whether the alert has been acknowledged by an operator
acknowledgedBy stringnull Username of the operator who acknowledged the alert
message string Alert message with details about the triggering condition
entityType string Type of the monitored entity that triggered the alert
entityUri string SWIS URI of the entity that triggered the alert
entityCaption string Display name of the triggering entity
triggerCondition object
notes string Additional notes or annotations on the alert
View JSON Schema on GitHub

JSON Schema

solarwinds-alert-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://solarwinds.com/schemas/solarwinds/alert.json",
  "title": "SolarWinds Alert",
  "description": "Schema for a SolarWinds monitoring alert triggered by threshold violations or status changes on monitored entities.",
  "type": "object",
  "required": [
    "alertId",
    "alertName",
    "severity",
    "triggeredAt"
  ],
  "properties": {
    "alertId": {
      "type": "integer",
      "description": "Unique identifier for the alert instance"
    },
    "alertName": {
      "type": "string",
      "description": "Display name of the alert definition"
    },
    "severity": {
      "type": "string",
      "description": "Alert severity level",
      "enum": [
        "Information",
        "Warning",
        "Critical",
        "Serious",
        "Notice"
      ]
    },
    "triggeredAt": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the alert was triggered"
    },
    "resetAt": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "Timestamp when the alert was reset, null if still active"
    },
    "acknowledged": {
      "type": "boolean",
      "description": "Whether the alert has been acknowledged by an operator",
      "default": false
    },
    "acknowledgedBy": {
      "type": ["string", "null"],
      "description": "Username of the operator who acknowledged the alert"
    },
    "message": {
      "type": "string",
      "description": "Alert message with details about the triggering condition"
    },
    "entityType": {
      "type": "string",
      "description": "Type of the monitored entity that triggered the alert",
      "examples": [
        "Orion.Nodes",
        "Orion.Volumes",
        "Orion.NPM.Interfaces"
      ]
    },
    "entityUri": {
      "type": "string",
      "description": "SWIS URI of the entity that triggered the alert"
    },
    "entityCaption": {
      "type": "string",
      "description": "Display name of the triggering entity"
    },
    "triggerCondition": {
      "$ref": "#/$defs/TriggerCondition"
    },
    "notes": {
      "type": "string",
      "description": "Additional notes or annotations on the alert"
    }
  },
  "$defs": {
    "TriggerCondition": {
      "type": "object",
      "description": "Condition that caused the alert to trigger",
      "properties": {
        "property": {
          "type": "string",
          "description": "Name of the monitored property"
        },
        "operator": {
          "type": "string",
          "description": "Comparison operator",
          "enum": [
            "Greater Than",
            "Less Than",
            "Equal To",
            "Not Equal To",
            "Greater Than or Equal To",
            "Less Than or Equal To"
          ]
        },
        "threshold": {
          "type": "number",
          "description": "Threshold value that was exceeded"
        },
        "currentValue": {
          "type": "number",
          "description": "Current value of the monitored property"
        },
        "duration": {
          "type": "integer",
          "description": "Duration in seconds the condition must persist before triggering",
          "minimum": 0
        }
      }
    }
  }
}