This document provides detailed information about the Monitoring Alerts API endpoints and their usage. Use the following guides to manage alerts effectively:

📌 Key Endpoints

  • GET /api/monitoring/alerts
    Retrieve a list of all active alerts.
    📌 Example Response: 

    {
  "alerts": [
    {"id": "ALRT123", "status": "active", "message": "High CPU usage detected"},
    {"id": "ALRT456", "status": "resolved", "message": "Disk space issue fixed"}
  ]
}

  • POST /api/monitoring/alerts
    Create a new alert rule.
    ⚠️ Required Parameters:

    • threshold: numeric value
    • resource_id: string
    • severity: "low" | "medium" | "high"

  • PUT /api/monitoring/alerts/{id}
    Update an existing alert's configuration.
    🔄 Example: 

    curl -X PUT /api/monitoring/alerts/ALRT123 -d '{"severity": "high"}'

  • DELETE /api/monitoring/alerts/{id}
    Silence or remove an alert.

📚 Related Resources

For deeper insights into alert configurations, visit our Alert Configuration Guide.

📷 Visual Overview

monitoring_alarms
*Understanding alert states and triggers*

For real-time monitoring tools, check out Monitoring Tools to visualize alert trends.

Note: All endpoints require authentication via API key in the request headers.