Coralogix Terraform Provider

Last Updated: Nov. 01, 2023

The Coralogix terraform provider is used to interact with the resources supported by Coralogix. The provider needs to be configured with the proper credentials before it can be used. It requires terraform v1.3.0 or later.

View the latest version of our comprehensive usage guide in the terraform registry to learn more and view examples of how to use the terraform provider to manage Coralogix resources and APIs.

You can also view our open source code in its official GitHub repository.

Prerequisites

Sign up for a Coralogix account. Set up your account on the Coralogix domain corresponding to the region within which you would like your data stored.
Access your Coralogix API key:
- In your Coralogix account, open the Data Flow dropdown menu in the toolbar, and select API Keys.
- On the API Keys page, copy the information in the Alerts, Rules and Tags API Key field.

Install Terraform.

Configuration

Example Usage

provider "coralogix" {
  api_key = "<add your api key here or add env variable CORALOGIX_API_KEY>"
  env = "<add the environment where you want to work or add env variable CORALOGIX_ENV>"
}

resource "coralogix_rules_group" "my_first_rules_group" {
  name = "my first rules_group"
}

Authentication

The API key and desired environment for using the Coralogix provider can be set in two ways, either explicitly or implicitly through environment variables.

explicitly:

provider "coralogix" {
api_key = "<add your api key>"
env = "<add the environment where you want to work>"
}

implicitly:

$ export CORALOGIX_API_KEY="<add your api key>"

$ export CORALOGIX_ENV="<add the environment where you want to work>"

Argument Reference

api_key (string, sensitive). A key for alerts, rules, and events2metric APIs (auto-generated), appropriate for the defined environment.
env (string). The Coralogix API environment should be the region [“APAC1”, “APAC2”, “EUROPE1”, “EUROPE2”, or “USA1”] associated with your Coralogix domain.