Data Management Service API - Splunk Enterprise

Use the dmx_cmp app to manage local Data Management API endpoints for Edge Processors, destinations, and pipelines in Splunk Enterprise.

This guide is for platform administrators and automation authors. The app runs on Splunk Enterprise, not Splunk Cloud Platform, and requires Splunk Enterprise 10.6.0 or higher.

What the API manages

An Edge Processor deployment has four distinct components:

  1. A destination defines where processed events go.
  2. An Edge Processor resource defines the data inputs and the default destination in Splunk Enterprise.
  3. An Edge Processor instance is the running agent on a Linux host. Install it by executing the onboarding script that the API generates.
  4. A pipeline defines transformations and applies them to one or more registered Edge Processor instances.

Creating the Edge Processor resource does not install its agent. Complete both operations before you deploy a pipeline.

For access requirements, see API access and roles. To install and configure the app, see Install the Data Management API app and Configure the Data Management API. To deploy a pipeline, see Deploy an Edge Processor pipeline.