API Reference

Use the Edge Delta API to programmatically manage pipelines, alerts, and configurations. This page includes example calls and an interactive Swagger interface where you can explore available endpoints and test API requests directly.

  2 minute read  

See here for information on how to create an API token.

Click Admin and select the My Organization tab to view your Organization ID.

Example API Call

This example shows how to retrieve data about a particular pipeline configuration. It requires an API Token configured with Read access to the pipelines Resource. Replace <ORG_ID>, <APIToken>, and <Pipeline_ID>.

List Alerts

curl -X 'GET' \
  'https://api.edgedelta.com/v1/orgs/<ORG_ID>/confs/<Pipeline_ID>' \
  -H 'accept: application/json' \
  -H 'X-ED-API-Token: <APIToken>'

The output shows the metadata and the YAML configuration for the specified pipeline:

{"id":"<Pipeline_ID>","orgID":"<ORG_ID>","tag":"fleet032","content":"version: v3\n\nsettings:\n  tag: fleet032\n  log:\n    level: info\n  archive_flush_interval: 1m0s\n  archive_max_byte_limit: 16MB\n\nlinks:\n- from: ed_source_detection\n  to: edgedelta\n- from: ed_component_health\n  to: edgedelta\n- from: ed_node_health\n  to: edgedelta\n- from: ed_agent_stats\n  to: edgedelta\n- from: ed_pipeline_io_stats\n  to: edgedelta\n- from: ed_system_stats\n  to: edgedelta\n- from: ed_k8s_metrics\n  to: edgedelta\n- from: k8s_traffic\n  to: edgedelta\n- from: k8s_event\n  to: edgedelta\n- from: mask_ssn\n  to: drop_trace_level\n- from: mask_ssn\n  to: error_monitoring\n- from: mask_ssn\n  to: exception_monitoring\n- from: mask_ssn\n  to: log_to_patterns\n- from: mask_ssn\n  to: negative_sentiment_monitoring\n- from: drop_trace_level\n  to: edgedelta\n- from: error_monitoring\n  to: edgedelta\n- from: exception_monitoring\n  to: edgedelta\n- from: negative_sentiment_monitoring\n  to: edgedelta\n- from: log_to_patterns\n  to: edgedelta\n- from: kubernetes_input_ct9ec\n  to: mask_ssn\n- from: kubernetes_input_ct9ec\n  to: ed_debug\n\nnodes:\n- name: ed_source_detection\n  type: ed_source_detection_input\n- name: ed_component_health\n  type: ed_component_health_input\n- name: ed_node_health\n  type: ed_node_health_input\n- name: ed_agent_stats\n  type: ed_agent_stats_input\n- name: ed_pipeline_io_stats\n  type: ed_pipeline_io_stats_input\n- name: ed_system_stats\n  type: ed_system_stats_input\n- name: ed_k8s_metrics\n  type: ed_k8s_metrics_input\n- name: k8s_traffic\n  type: k8s_traffic_input\n- name: k8s_event\n  type: k8s_event_input\n  report_interval: 1m0s\n- name: mask_ssn\n  type: mask\n  pattern: \\d{3}\\-\\d{2}-\\d{4}\n  mask: REDACTED\n- name: drop_trace_level\n  type: regex_filter\n  pattern: TRACE\n  negate: true\n- name: error_monitoring\n  type: log_to_metric\n  pattern: (?i)error\n- name: exception_monitoring\n  type: log_to_metric\n  pattern: (?i)exception\n- name: negative_sentiment_monitoring\n  type: log_to_metric\n  pattern: (?i)(exception|fail|timeout|broken|caught|denied|abort|insufficient|killed|killing|malformed|unsuccessful|outofmemory|panic|undefined)\n- name: log_to_patterns\n  type: log_to_pattern\n  reporting_frequency: 1m0s\n- name: edgedelta\n  type: ed_output\n- name: ed_debug\n  type: ed_debug_output\n- name: kubernetes_input_ct9ec\n  type: kubernetes_input\n  include:\n  - k8s.namespace.name=.*\n  exclude:\n  - k8s.pod.name=edgedelta\n","description":"fleet032","creator":"me@example.com","created":"2024-11-25 23:59:06.732483257 +0000 UTC","updater":"me@example.com","updated":"2024-12-05 03:32:15.624631947 +0000 UTC","retrieved":"2024-12-05 02:11:33.17715696 +0000 UTC","version":"v3","metadata":{"compound_nodes":{"updated":[],"updates_available":[],"deleted":[]}},"environment":"Helm"}

Swagger