Migrating from Alerts v2 to v3

Coralogix Alerts API v3 introduces advanced alert management features such as multiple conditions, anomaly detection sensitivity customization, custom evaluation delays. Migrating to v3 is recommended to take advantage of these and future capabilities, as well as to streamline your alerting configurations. This guide offers migration options for UI, Terraform, and API users.

Note

If you use legacy versions (API v2 or Terraform Provider v1), new features will remain disabled.

The Alerts API v2 continues to be fully supported and stable. Although there are currently no plans for deprecation, all new alert feature development will only available in the v3 API. Customers are encouraged to adopt v3 to take advantage of its advanced functionality and continuous enhancements.

How to access Alerts API v3 features

To access Alerts API v3, you’ll need to confirm your eligibility with Coralogix Support. You must meet at least one of the following conditions:

You are not using third-party API tools or Terraform Provider to manage alerts.
You have successfully migrated to Alerts API v3 and/orTerraform Provider v2.

Once verified, Coralogix Support will enable the new features.

Migration options

If you’re still using Alerts API v2 or Terraform Provider v1, Alerts v3 features will remain disabled. To access the latest capabilities, consider migrating to supported versions.

Coralogix user interface

Once you have accessed Alerts API v3 features, they will appear in the Coralogix UI.

Terraform

Terraform Provider v2 supports the enhanced capabilities of Alerts v3.

To upgrade from v1 to v2, follow this Terraform Migration Guide for Alerts.

Note: The legacy Terraform Provider v1 remains fully operational.

APIs

Integrate with Alerts v3 using our gRPC API. For a detailed comparison between Alerts API v2 and v3, see our API documentation.

Notable differences between v2 and v3 APIs:

Severity-to-Priority Mapping - In V3, alert severities are now translated into defined priority levels (e.g., Critical maps to P1, Error to P2)
Deprecation of evaluationWindow - The evaluationWindow field, used in V2 for dynamic duration, has been deprecated in V3 in favor of a rolling window approach.
Removal of Lucene-Based Metric Alerts - Alerts V3 no longer supports Lucene-based metric alerts defined with Lucene queries, a feature available in V2. This removal affects users relying on Lucene queries for metric alerting.
Introduction of V3-Specific Metadata Fields - New fields, such as incidentId, relatedUser, and rbacGroupName are introduced in V3 to enhance alert context.

gRPC API

To learn about the gRPC version of Alerts API v3, visit our gRPC documentation.

Support

Need help?

Our world-class customer success team is available 24/7 to walk you through your setup and answer any questions that may come up.

Feel free to reach out to us via our in-app chat or by sending us an email to support@coralogix.com.

Getting Started With Coralogix APIs

Next Alerts API v1/v2