This document provides an overview of the alert configuration API, which allows users to manage and configure alerts within the monitoring system.
API Endpoints
- GET
/en/api-docs/monitoring-practices/alert-configuration
- Retrieves information about the alert configuration API.
Usage
To retrieve the alert configuration details, make a GET request to the above endpoint.
Response Format
The API returns a JSON object with the following structure:
{
"status": "success",
"data": {
"alert_id": "12345",
"alert_name": "High CPU Usage",
"alert_description": "This alert is triggered when the CPU usage exceeds 90% for more than 5 minutes.",
"alert_actions": ["send email", "log to file", "restart service"],
"alert_threshold": 90,
"alert_duration": 300
}
}
Example Request
curl -X GET "https://api.example.com/en/api-docs/monitoring-practices/alert-configuration"
Image
[
High CPU Usage Alert
Additional Resources
For more information on monitoring practices and alert configuration, please refer to the following resources:
Please note that the alert configuration API is subject to change without prior notice.