Skip to main content

Coralogix Developer Docs home page

Support

Introduction

Getting started

Use Cases

Copy a dashboard
Create an alert with an outgoing webhook
Setup kubernetes complete observability integration

Actions Service

Overview
POST
Atomic Batch Execute Actions
POST
Create Action
DEL
Delete Action
GET
Get Action
GET
List Actions
POST
Order Actions
PUT
Replace Action

Alert Definitions Service

Overview
POST
Create an alert
DEL
Delete v3alert defs
POST
Disable or enable an alert
GET
Download alerts
GET
Get a list of all accessible alert definitions
GET
Get alert definition by alert version ID
GET
Get alert definition by ID
PUT
Replace an alert definition

Alert Events Service

Overview
GET
Get alert event by ID
GET
Get alert events statistics

API Keys Service

Overview
POST
Create API Key
DEL
Delete API Key
GET
Get "Send Data" API Keys
GET
Get API Key
PUT
Update API Key

Contextual Data Integration Service

Overview
DEL
Delete contextual data integration
GET
Get all contextual data integrations accessible
GET
Get contextual data integration definition
GET
Get contextual data integration details
POST
Save contextual data integration
POST
Test contextual data integration
PUT
Update contextual data integration

Custom Enrichments Service

Overview
POST
Create Custom Enrichments
DEL
Delete Custom Enrichments
GET
Get Custom Enrichment
GET
Get Custom Enrichments
POST
Search Custom Enrichment Data
PUT
Update Custom Enrichment

Dashboard Folders Service

Overview
POST
Create a dashboard folder
DEL
Delete a dashboard folder
GET
Get a dashboard folder
GET
List dashboard folders
PUT
Replace a dashboard folder

Dashboard Service

Overview
PATCH
Add dashboard to favorites
POST
Assign a dashboard to a folder
POST
Create a new dashboard
DEL
Delete a dashboard
GET
Get a dashboard
GET
Get a dashboard by URL slug
GET
Get dashboard catalog
PATCH
Remove dashboard from favorites
PUT
Replace a dashboard
PUT
Replace the default dashboard

Data Usage Service

Overview
POST
Get Daily Usage Evaluation Tokens
POST
Get Daily Usage Processed GBs
POST
Get Daily Usage Units
GET
Get Data Usage
GET
Get Data Usage Metrics Export Status
GET
Get Logs Count
GET
Get Spans Count
POST
Update Data Usage Metrics Export Status

Enrichments Service

Overview
POST
Add Enrichments
PATCH
Atomic Overwrite Enrichments
DEL
Delete Enrichments
GET
Get Company Enrichment Settings
GET
Get Enrichment Limit
GET
Get Enrichments

Events Service

Overview
GET
Batch Get Event
GET
Get Event
GET
Get Events Statistics
GET
List Events
GET
List Events Count

Events2Metrics Service

Overview
POST
Atomic Batch Execute E2M
POST
Create a new E2M
DEL
Delete an E2M
GET
Get an E2M
GET
Get E2M Limits
GET
List E2M Labels Cardinality
GET
List E2Ms
PUT
Replace an E2M

Extension Deployment Service

Overview
POST
Deploy extension
GET
Get deployed extensions
POST
Revert deployment of extension
POST
Update extension

Extension Service

Overview
POST
Get all extensions
GET
Get extension by ID

Extension Testing Service

Overview
POST
Cleanup testing extension
POST
Initialize testing revision
POST
Test extension revision

Folders for Views

Overview
POST
Create View Folder service
DEL
Delete View Folder service
GET
Get View Folder service
GET
List view folders service
PUT
Replace View Folder service

Incidents Service

Overview
POST
Acknowledge incidents
POST
Assign incidents to a user
POST
Close incidents
POST
Get available filter values
POST
Get available incident event filter values
POST
Get incident aggregations
GET
Get incident by ID
GET
Get incident events
POST
Get multiple incidents by IDs
POST
Get total count of incident events
POST
List incident events with filters
POST
List incidents with filters
POST
Remove incident user assignments
POST
Resolve incidents

Integration Service

Overview
DEL
Delete integration
GET
Get all integrations
GET
Get deployed integration
GET
Get integration definition
GET
Get integration details
GET
Get integration template
GET
Get managed integration status
GET
Get RUM integration versions data
GET
List managed integration keys
POST
Save integration registration metadata
POST
Test integration
POST
Trigger sync of RUM integration data
PUT
Update integration

Outgoing Webhooks Service

Overview
POST
Create an outgoing webhook
DEL
Delete an outgoing webhook
GET
Get outgoing webhook
GET
Get outgoing webhook type details
GET
Get outgoing webhook types
GET
List all outgoing webhooks
GET
List IBM event notification instances
GET
List outbound webhooks summary
GET
List outgoing webhooks
POST
Test an existing outgoing webhook
POST
Test an outgoing webhook
PUT
Update an outgoing webhook

Policies Service

Overview
POST
Atomic Batch Create Policy
POST
Atomic Overwrite Log Policies
POST
Atomic Overwrite Span Policies
POST
Bulk Test Log Policies
DEL
Delete Policy
GET
Get Company Policies
POST
Get Policy by ID
GET
Get Policy by ID
POST
Reorder Policies
POST
Toggle Policies
PUT
Update Policy

Recording Rules Service

Overview
POST
Create Recording Rules
DEL
Delete Recording Rules
GET
Get Recording Rules
GET
List Recording Rules
PUT
Update Recording Rules

Retentions Service

Overview
POST
Activate Retentions
GET
Get Retentions
GET
Get Retentions Enabled
POST
Update Retentions

Rule Groups Service

Overview
DEL
Bulk Delete Rule Group
POST
Create Rule Group
DEL
Delete Rule Group
POST
Get Company Usage Limits
GET
Get Rule Group
POST
Get Rule Group Model Mapping
GET
List Rule Groups
PUT
Update Rule Group

SAML Configuration Service

Overview
POST
Activate/Deactivate SAML
GET
Get SAML Configuration
GET
Get SP Parameters
POST
Set IDP Parameters

Scopes Service

Overview
POST
Create Scope
DEL
Delete Scope
GET
Get Team Scopes
GET
Get Team Scopes By Ids
PUT
Update Scope

Slos Service

Overview
POST
Batch Execute Slo
GET
Batch Get Slo
POST
Create Slo
DEL
Delete Slo
GET
Get Slo
GET
List Slos
PUT
Replace Slo

Target Service

Overview
GET
Get target
POST
Set target
POST
Validate target

Team Permissions Management Service

Overview
POST
Add Users To Team Group
POST
Add Users To Team Groups
POST
Create Team Group
DEL
Delete Team Group
GET
Get Group Users
GET
Get Team Group
GET
Get Team Group By Name
GET
Get Team Group Scope
GET
Get Team Groups
DEL
Remove Users From Team Group
DEL
Remove Users From Team Groups
POST
Set Team Group Scope
PUT
Update Team Group

Views

Overview
POST
Create a view service
DEL
Delete view service
GET
Get view service
GET
List views service
PUT
Replace a view service

Retentions service overview
Constants

Retentions Service

Overview

Retentions service overview

Constants

Was this page helpful?

Update Recording Rules Activate Retentions

⌘I

github linkedin x

Powered by Mintlify