This section provides an overview of the alert management API available on our platform. Alerts are crucial for monitoring and responding to various events and issues.

Features

  • Real-time Monitoring: Receive instant alerts when critical events occur.
  • Customizable Alerts: Configure alerts based on specific conditions and triggers.
  • Integration with Other Tools: Integrate with popular monitoring and incident response tools.

Usage

To get started with the alert management API, follow these steps:

  1. Register for an account on our platform.
  2. Once logged in, navigate to the API Dashboard.
  3. Click on "Alert Management" to access the API documentation and start using the API.

API Endpoints

Here are the available endpoints for the alert management API:

  • GET /en/api-docs/alert-management/list: Lists all the alerts.
  • POST /en/api-docs/alert-management/create: Creates a new alert.
  • PUT /en/api-docs/alert-management/update/: Updates an existing alert.
  • DELETE /en/api-docs/alert-management/delete/: Deletes an alert.

Example

Here's an example of how to use the API to create a new alert:

POST /en/api-docs/alert-management/create
Content-Type: application/json

{
  "name": "High CPU Usage",
  "description": "Trigger an alert when the CPU usage exceeds 90% for 5 minutes.",
  "trigger": "cpu_usage > 90",
  "duration": 300,
  "repeat": true
}

Resources

For more information on alert management, check out our Alert Management Guide.

Alert Management