Alert Configuration API Reference

This section provides a comprehensive guide to the Alert Configuration API, which allows users to manage and configure alerts within the system.

Overview

The Alert Configuration API enables users to create, update, and delete alerts. It also provides endpoints to retrieve information about existing alerts.

Endpoints

List Alerts

Retrieve a list of all alerts configured in the system.

• URL: /API_Reference/en/Full/Alert_Configuration/alerts
• Method: GET

Create Alert

Create a new alert with specified parameters.

• URL: /API_Reference/en/Full/Alert_Configuration/alerts
• Method: POST
• Parameters:
  • name: The name of the alert.
  • description: A brief description of the alert.
  • threshold: The threshold value for triggering the alert.
  • trigger_condition: The condition under which the alert should be triggered.

Update Alert

Update an existing alert with new parameters.

• URL: /API_Reference/en/Full/Alert_Configuration/alerts/{alert_id}
• Method: PUT
• Parameters:
  • name: The new name of the alert (optional).
  • description: The new description of the alert (optional).
  • threshold: The new threshold value for triggering the alert (optional).
  • trigger_condition: The new condition under which the alert should be triggered (optional).

Delete Alert

Delete an existing alert.

• URL: /API_Reference/en/Full/Alert_Configuration/alerts/{alert_id}
• Method: DELETE

Usage Example

To create a new alert, you can use the following API call:

curl -X POST https://yourdomain.com/API_Reference/en/Full/Alert_Configuration/alerts \
-H "Content-Type: application/json" \
-d '{"name": "High CPU Usage", "description": "Alert when CPU usage exceeds 90%", "threshold": 90, "trigger_condition": "cpu_usage"}'

For more information on how to use the Alert Configuration API, please refer to our API Documentation.

Alert Configuration