Our next-gen architecture is built to help you make sense of your ever-growing data Watch a 4-min demo video!

Back to All Docs

Coralogix Private Key

Last Updated: Mar. 30, 2023

In order to send your data to Coralogix, you are required to access and use your unique Coralogix API private key.

This tutorial demonstrates how to access the default private key associated with your Coralogix account, as well as to add unlimited private keys with advanced security settings.

Note! Customers wishing to enjoy unlimited private keys with advanced security settings should reach out to us via our in-app chat or by sending us an email at [email protected].

Feature

In order to send your data to Coralogix, you are required to access and use your unique Coralogix API private key. This sensitive information is required to send us your telemetry data securely and allows us to authenticate the identity of those sending it.

Coralogix offers its customers the option of creating multiple private keys with advanced security settings, allowing you to:

  • Minimize security vulnerabilities
  • Utilize different keys across different systems, deployment methods, and teams
  • Avoid the need to revoke one private key in all of your systems, as well as the associated downtime, in the event of exposure

Our recommended best practice is to create multiple keys for your organization with all keys enjoying our advanced security settings.

Notes:

Manage Private Keys

The following section demonstrates how to (i) view and create private keys and (ii) set up your advanced security settings.

View and Create Private Keys

STEP 1. In your Coralogix account, open the Data Flow dropdown menu in the toolbar > API Keys.

STEP 2. Under the heading Send your Data, you will see your default private key, which you can view and copy, as well as any other keys that you have created.

STEP 3. Click +ADD NEW PRIVATE KEY to add a private key.

STEP 4. Input a key name and click CREATE.

STEP 5. The system will generate your key. Click VIEW or DOWNLOAD.

STEP 6. Click DONE.

Your new key will now appear with all of your existing keys under the Send your Data heading with its name and date of creation. View, copy, activate, deactivate and even delete it on your Coralogix UI as necessary.

Notes:

  • Once a key is generated, only its name can be changed.
  • If a key is deactivated and reactivated, it is reactivated with the same value.
  • Your default key can never be deleted.

Advanced Security Settings

Private keys created after the API Key Security Settings have been activated will be encrypted, without the possibility of viewing them after their creation.

STEP 1. To enjoy advanced security settings, navigate to your personal account > Settings.

STEP 2. In the left-hand sidebar, select API Key Security Settings. Activate or deactivate as required.

Notes:

  • Only account administrators have permissions to activate these settings.
  • Once these settings are in place, they will apply to new keys generated after this time.

STEP 3. Open the Data Flow dropdown menu in the toolbar > API Keys.

STEP 4. Under the Send your Data heading, you will see your default private key, as well as any other additional keys that you have generated. View the names and dates of keys, as well as the value of those keys created prior to the activation of the advanced security settings. You will not have the option to view and copy the value of any new keys created after the API Key Security Settings have been activated.

Note:

  • When generating a new key once the API Key Security Settings have been activated, you will have a one time opportunity to view and copy it on your UI upon its creation. You will be required to download it as a text file to be save locally.

Additional Resources

Documentation: Private Keys Management API

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 at [email protected].

On this page