Getting Started With Coralogix APIs

Unlock the full power of Coralogix’s observability platform with our suite of APIs. Use them to send data, build dashboards, manage resources, and run advanced queries across logs, metrics, traces, and more.

This guide will help you get started by covering authentication, core concepts, and API categories—so you can integrate, automate, and scale with confidence.

Read on to learn about our Data Ingestion, Data Management, and Data Query APIs and how to use them.

Open-API HTTP APIs

Visit our new HTTP API documentation page to learn how to use the following services and many others:

Prerequisites

To interact with the Coralogix API, you'll need to authenticate your requests using your unique API keys. Coralogix's adaptable RBAC management system allows you to assign specific permissions or groups of permissions, known as role presets, to each API key, ensuring precise control over access and operations. Learn more about creating and using our API keys here.

Every API page specifies the relevant permissions required to access and use the relevant functionalities. For example, in the HTTP API, the required permissions are listed for every method:

Send your data to Coralogix

Data ingestion APIs

Data is ingested seamlessly and reliably into the Coralogix platform using our Data Ingestion APIs.

HTTP

API name	Usage
Logs	Send us your logs using either our `/logs` or `/singles` endpoint.

Manage your data

The Data Management APIs enable you to configure the Coralogix platform, customize your user interface, and optimize it for your observability requirements.

HTTP

API name	Usage
Alerts	Coralogix gives you the ability to create monitors that actively check system performance and notify you when there are changes to your data. Our Alerts API allows you to define, query, and manage your alerts.
Incidents Management	Manage your reported incidents by listing individual or batch metadata, aggregating incidents, as well as assigning/unassigning incidents or resolving chosen events.
Extensions and integrations	Coralogix provides a suite of out-of-the-box data extensions, each designed to deliver predefined resources—such as alerts, parsing rules, dashboards, saved views, and actions—to expedite the monitoring setup of your external-facing systems. You can also manage integrations and webhooks directly for a customized approach.
Parsing Rules	Use our log parsing rules to process, parse, and restructure log data for monitoring and analysis in the Coralogix platform. Create, read, update, or delete these rules and rule groups for your data.
Enrichment	Easily enrich your log data with business, operations, or security information using our Enrichment API. Automatically add fields to your JSON logs based on specific matches in your log data, using a predefined custom data source of your choice.
Hosted Grafana	Visualize your logs, metrics, and traces using our Grafana-hosted view without the need for any plugins. We provide a secure Grafana API to manage your Grafana-hosted dashboard, allowing you to create, edit, export, import, and query your data on that platform.
TCO Optimizer	Define, query, and manage your TCO log policy overrides.
Insights	Manage our Insights Detection service, automatically detecting possible threats and security-related anomalies in your traffic.
Service Removal	Even if services no longer exist on your side, the catalog in Coralogix lists all previously imported services indefinitely. With the Service Removal API, you can manually remove one or more unused services from your Coralogix subscription.
Actions	Coralogix Actions provide powerful automation capabilities that trigger workflows based on data conditions.
APM	Coralogix APM delivers comprehensive application performance monitoring with Service Level Objective (SLO) tracking.
Archive	Coralogix Archive provides intelligent data lifecycle management to optimize storage costs while maintaining compliance.
Data Usage	Coralogix Data Usage provides detailed insights into your observability data consumption patterns.
Logs2Metrics	Coralogix Logs2Metrics transforms log events into actionable metrics for enhanced monitoring.
Permissions	Coralogix Permissions provide granular role-based access control to secure your observability data.
Quota	Coralogix Quota provides resource allocation and usage enforcement to optimize platform utilization.
Scopes	Coralogix Scopes provide data isolation and access control through logical data partitioning.
Views	Coralogix Views allow you to save and organize filtered data queries for fast access and shared analysis.
Rule Groups	Coralogix Rule Groups allow you to organize and manage log parsing rules in structured, ordered collections.
Recording Rules	Coralogix Recording Rules let you define PromQL-based expressions that are periodically evaluated and stored as new time series for downstream analysis. Recording rules help optimize performance by precomputing frequently used queries and metrics. The API supports full CRUD operations for rule groups and rule group sets, including versioned updates and interval-based scheduling.
Events	Coralogix Events exposes historical data about triggered incidents. It enables teams to query, paginate, and analyze alert event occurrences.

Query your data

Access and query your data using our Data Query APIs.

HTTP

API Name	Usage
Direct Query	Run DataPrime or Lucene queries of your indexed and archived logs without the need to access your Coralogix UI.

Visualize your data

Use our Dashboards API to build, customize, and organize powerful data visualizations at scale.

HTTP

API Name	Usage
Dashboards	Create, manage, and organize dashboards and widgets through core operations, catalog browsing, and folder management.

Additional resources

2.1 - Basics of Regions and API Keys

Support

Need help?

Our world-class customer success team is available 24/7 to 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 support@coralogix.com.

Developer Portal

Next Platform as a Service (PaaS)