Manage Coralogix data pipelines including dashboards, views, actions, rule groups, events-to-metrics, enrichments, recording rules, integrations, extensions, webhooks, connectors, presets, global routers, and data archiving.
This skill covers all data pipeline and configuration management operations in Coralogix: dashboards, saved views, parsing rules, enrichments, events-to-metrics, recording rules, integrations, webhooks, connectors, notification presets, global routers, and archive targets.
Auth/region setup: See coralogix-core skill. Set CORALOGIX_API_KEY and CORALOGIX_REGION before running any action.
python .augment/skills/coralogix-data/scripts/data_api.py --action <ACTION> [OPTIONS]
Options:
--action ACTION Required. One of the actions listed below.
--body JSON Request body as JSON string (for POST/PUT/DELETE with body).
--params JSON Query parameters as JSON string.
--path-params JSON Path parameters as JSON string (e.g. '{"id":"abc123"}').
--region REGION Region code: eu1, eu2 (default), us1, us2, ap1, ap2, ap3.
--api-key KEY API key (overrides $CORALOGIX_API_KEY).
--max-output N Truncate response at N chars (default: 10000).
--dry-run Show what a POST/PUT/DELETE/PATCH would do without executing it.
Prints a JSON summary of the planned request and exits 0.
GET operations still run normally (a note is printed to stderr).
# List all dashboards catalog
python data_api.py --action get-dashboard-catalog
# Create a dashboard
python data_api.py --action create-dashboard --body '{"dashboard": {...}}'
# Get a specific dashboard
python data_api.py --action get-dashboard --path-params '{"dashboard_id": "abc123"}'
# List all webhooks
python data_api.py --action list-all-webhooks
# Create a webhook
python data_api.py --action create-webhook --body '{"webhook": {...}}'
# List connectors
python data_api.py --action list-connectors
# List integrations
python data_api.py --action list-integrations
# List rule groups
python data_api.py --action list-rule-groups
# List events-to-metrics
python data_api.py --action list-e2m
# Get recording rule groups
python data_api.py --action list-recording-rule-groups
# Dry-run: preview a POST without executing it
python data_api.py --action create-rule-group --body '{"name":"test"}' --dry-run
# Dry-run on a GET: runs normally (dry-run has no effect on reads)
python data_api.py --action list-rule-groups --dry-run
| Action | Method | Description |
|---|---|---|
get-dashboard-catalog | GET | Get the dashboard catalog |
get-dashboard-by-slug | GET | Get dashboard by slug ({slug}) |
create-dashboard | POST | Create a new dashboard |
replace-dashboard | PUT | Replace an existing dashboard |
get-dashboard | GET | Get dashboard by ID ({dashboard_id}) |
delete-dashboard | DELETE | Delete dashboard ({dashboard_id}) |
replace-default-dashboard | PUT | Set default dashboard ({dashboard_id}) |
assign-dashboard-folder | POST | Assign dashboard to folder ({dashboard_id}) |
pin-dashboard | PATCH | Pin dashboard ({dashboard_id}) |
unpin-dashboard | PATCH | Unpin dashboard ({dashboard_id}) |
| Action | Method | Description |
|---|---|---|
list-dashboard-folders | GET | List all dashboard folders |
create-dashboard-folder | POST | Create a dashboard folder |
replace-dashboard-folder | PUT | Replace a dashboard folder |
get-dashboard-folder | GET | Get folder by ID ({folder_id}) |
delete-dashboard-folder | DELETE | Delete folder ({folder_id}) |
| Action | Method | Description |
|---|---|---|
list-views | GET | List all saved views |
create-view | POST | Create a saved view |
get-view | GET | Get view by ID ({id}) |
replace-view | PUT | Replace a saved view ({id}) |
delete-view | DELETE | Delete a saved view ({id}) |
| Action | Method | Description |
|---|---|---|
list-view-folders | GET | List view folders |
create-view-folder | POST | Create a view folder |
replace-view-folder | PUT | Replace a view folder |
get-view-folder | GET | Get view folder ({id}) |
delete-view-folder | DELETE | Delete view folder ({id}) |
| Action | Method | Description |
|---|---|---|
list-actions | GET | List all actions |
create-action | POST | Create an action |
replace-action | PUT | Replace an action |
get-action | GET | Get action by ID ({id}) |
delete-action | DELETE | Delete an action ({id}) |
batch-execute-actions | POST | Atomic batch execute actions |
order-actions | POST | Reorder actions |
| Action | Method | Description |
|---|---|---|
list-rule-groups | GET | List all rule groups |
create-rule-group | POST | Create a rule group |
get-rule-group | GET | Get rule group ({group_id}) |
update-rule-group | PUT | Update rule group ({group_id}) |
delete-rule-group | DELETE | Delete rule group ({group_id}) |
bulk-delete-rule-groups | DELETE | Bulk delete rule groups |
get-rule-group-limits | POST | Get company usage limits |
get-rule-group-model-mapping | POST | Get rule group model mapping |
| Action | Method | Description |
|---|---|---|
list-e2m | GET | List all E2M rules |
create-e2m | POST | Create an E2M rule |
replace-e2m | PUT | Replace an E2M rule |
get-e2m | GET | Get E2M rule ({id}) |
delete-e2m | DELETE | Delete E2M rule ({id}) |
batch-execute-e2m | POST | Atomic batch execute E2M |
list-e2m-label-cardinality | GET | List labels cardinality |
get-e2m-limits | GET | Get E2M limits |
| Action | Method | Description |
|---|---|---|
list-custom-enrichments | GET | List custom enrichments |
create-custom-enrichment | POST | Create custom enrichment |
update-custom-enrichment | PUT | Update custom enrichment |
get-custom-enrichment | GET | Get custom enrichment ({id}) |
delete-custom-enrichment | DELETE | Delete custom enrichment ({custom_enrichment_id}) |
search-custom-enrichment-data | POST | Search enrichment data |
| Action | Method | Description |
|---|---|---|
get-enrichments | GET | Get all enrichments |
add-enrichments | POST | Add enrichments |
overwrite-enrichments | PUT | Atomic overwrite enrichments |
remove-enrichments | DELETE | Remove enrichments |
get-enrichment-limit | GET | Get enrichment limit |
get-enrichment-settings | GET | Get company enrichment settings |
| Action | Method | Description |
|---|---|---|
list-recording-rule-groups | GET | List recording rule group sets |
create-recording-rule-group | POST | Create a rule group set |
get-recording-rule-group | GET | Get rule group set ({id}) |
update-recording-rule-group | PUT | Update rule group set ({id}) |
delete-recording-rule-group | DELETE | Delete rule group set ({id}) |
| Action | Method | Description |
|---|---|---|
list-integrations | GET | List all integrations |
get-integration-definition | GET | Get integration definition ({id}) |
get-deployed-integration | GET | Get deployed integration ({integration_id}) |
delete-integration | DELETE | Delete integration instance ({integration_id}) |
list-managed-integration-keys | GET | List managed integration keys |
get-managed-integration-status | GET | Get managed integration status ({integration_id}) |
save-integration | POST | Save integration metadata |
update-integration | PUT | Update integration metadata |
test-integration | POST | Test integration |
get-rum-app-versions | GET | Get RUM application version data |
sync-rum-data | POST | Sync RUM data |
get-integration-template | GET | Get integration template |
get-integration-details | GET | Get integration details ({id}) |
| Action | Method | Description |
|---|---|---|
list-extensions | POST | Get all extensions |
get-extension | GET | Get extension ({id}) |
list-deployed-extensions | GET | Get deployed extensions |
deploy-extension | PUT | Deploy an extension |
update-deployed-extension | POST | Update a deployed extension |
undeploy-extension | DELETE | Undeploy an extension |
test-extension-revision | POST | Test extension revision |
cleanup-extension-testing | DELETE | Cleanup testing revision |
initialize-extension-testing | POST | Initialize testing revision |
| Action | Method | Description |
|---|---|---|
list-all-webhooks | GET | List all outgoing webhooks |
create-webhook | POST | Create a webhook |
update-webhook | PUT | Update a webhook |
get-webhook | GET | Get webhook ({id}) |
delete-webhook | DELETE | Delete webhook ({id}) |
list-webhook-summary | GET | List webhook summaries |
test-webhook | POST | Test a new webhook config |
test-existing-webhook | POST | Test an existing webhook |
list-webhook-types | GET | List webhook types |
get-webhook-type-details | GET | Get webhook type details ({type}) |
list-webhooks-by-type | GET | List webhooks filtered by type |
| Action | Method | Description |
|---|---|---|
get-s3-target | GET | Get S3 archive target config |
set-s3-target | POST | Set S3 archive target |
get-metrics-config | GET | Get metrics archive config |
update-metrics-config | PUT | Update metrics archive config |
configure-metrics-tenant | POST | Configure metrics tenant |
disable-metrics-archive | POST | Disable metrics archive |
enable-metrics-archive | POST | Enable metrics archive |
validate-metrics-bucket | POST | Validate archive bucket |
| Action | Method | Description |
|---|---|---|
list-connectors | GET | List all connectors |
create-connector | POST | Create a connector |
replace-connector | PUT | Replace a connector |
get-connector | GET | Get connector ({id}) |
delete-connector | DELETE | Delete connector ({id}) |
batch-get-connectors | GET | Batch get connectors |
batch-get-connector-summaries | GET | Batch get connector summaries |
get-connector-type-summaries | GET | Get connector type summaries |
list-connector-summaries | GET | List connector summaries |
| Action | Method | Description |
|---|---|---|
create-custom-preset | POST | Create custom preset |
replace-custom-preset | PUT | Replace custom preset |
delete-custom-preset | DELETE | Delete custom preset ({id}) |
set-custom-preset-default | POST | Set custom preset as default ({id}) |
get-preset | GET | Get preset ({id}) |
set-preset-default | POST | Set preset as default ({id}) |
batch-get-presets | GET | Batch get presets |
get-default-preset-summary | GET | Get default preset summary |
list-preset-summaries | GET | List preset summaries |
get-system-default-preset-summary | GET | Get system default preset summary |
| Action | Method | Description |
|---|---|---|
list-global-routers | GET | List global routers |
create-global-router | POST | Create a global router |
replace-global-router | PUT | Replace a global router |
get-global-router | GET | Get global router ({id}) |
delete-global-router | DELETE | Delete global router ({id}) |
batch-get-global-routers | GET | Batch get global router summaries |
| Action | Method | Description |
|---|---|---|
get-quota-rule-set | GET | Get quota allocation rule set |
create-quota-rule-set | POST | Create quota allocation rule set |
replace-quota-rule-set | PUT | Replace quota allocation rule set |
delete-quota-rule-set | DELETE | Delete quota allocation rule set |
| Action | Method | Description |
|---|---|---|
list-contextual-integrations | GET | List contextual data integrations |
save-contextual-integration | POST | Save contextual data integration |
update-contextual-integration | PUT | Update contextual data integration |
get-contextual-integration-definition | GET | Get integration definition ({id}) |
test-contextual-integration | POST | Test contextual integration |
get-contextual-integration-details | GET | Get integration details ({id}) |
delete-contextual-integration | DELETE | Delete integration ({integration_id}) |
| Action | Method | Description |
|---|---|---|
list-entity-types | GET | List notification entity types |
list-entity-subtypes | GET | List entity subtypes ({entity_type}) |
| Action | Method | Description |
|---|---|---|
get-connector-schema | GET | Get connector JSON schema |
test-connector-config | POST | Test connector configuration |
test-destination | POST | Test a destination |
test-existing-connector | POST | Test an existing connector |
test-existing-preset | POST | Test an existing preset |
test-preset-config | POST | Test preset configuration |
test-routing-condition | POST | Test routing condition validity |
test-template-render | POST | Test template render |
validate-entity-label-matcher | POST | Validate entity label matcher |
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Client/configuration error |
| 2 | API error (4xx/5xx) |
| 3 | Authentication error (401/403) |
Authorization: <key> — no Bearer prefix. Using Bearer will cause 401 errors.certifi as a fallback automatically, but if you see SSL errors, run: pip install certifi.--body. Invalid JSON will fail at the client, not the API.--max-output flag truncates the JSON response. If you get truncated data, increase the limit or omit the flag.scripts/data_api.py — Self-contained script (embeds CoralogixClient)references/DATA_SCHEMAS.md — Key request/response schemascoralogix-core skill — Auth and region setup details