Splunk integration

Splunk: search, alerts, dashboards, saved searches, data input

Help CentreConnectors

Overview

Splunk is the leading log + event analytics platform. The Automize Splunk connector covers search, alerts, dashboards, saved searches, data input.

  • Regions: Splunk Cloud (multi-region) or Splunk Enterprise (self-hosted).
  • Plans: By data volume + GB ingest/day.

Setting up the connection

Auth type: Bearer Token.

  1. Splunk admin → User → Token.
  2. In Automize → Settings → Connectors → Splunk. Paste token + Splunk URL.

Find your credentials at https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTaccess.


Rate limits

Per-deployment capacity.


Data model

Splunk primitives:

    Index ─── Events (timestamped logs)
    Search Job ─── Results
    Alert + Saved Search
    Dashboard

Available operations

21 operations available. Click any row to jump to its detail.

OperationCategoryWhat it does
Create IndexGeneralCreate a new index
Create Saved SearchGeneralCreate a new saved search
Dispatch Saved SearchGeneralRun a saved search
Get DashboardGeneralGet a dashboard by name
Get IndexGeneralGet index details
Get KV Store DataGeneralGet data from a KV store collection
Get Saved SearchGeneralGet a saved search by name
Get Search ResultsGeneralGet results of a search job
Get Search StatusGeneralGet status of a search job
Get Server InfoGeneralGet server information
Insert KV Store DataGeneralInsert data into a KV store collection
List AlertsGeneralList fired alerts
List AppsGeneralList installed apps
List DashboardsGeneralList all dashboards
List IndexesGeneralList all indexes
List InputsGeneralList all data inputs
List KV Store CollectionsGeneralList KV store collections
List Saved SearchesGeneralList all saved searches
Oneshot SearchGeneralRun a oneshot search that returns results immediately
SearchGeneralCreate a search job
Submit EventGeneralSend raw event data to an index

Operations

Create Index

Create a new index

No input parameters.


Create a new saved search

No input parameters.


Run a saved search

ParameterRequiredTypeDescription
Name nameYestext

Get Dashboard

Get a dashboard by name

ParameterRequiredTypeDescription
Name nameYestext

Get Index

Get index details

ParameterRequiredTypeDescription
Name nameYestext

Get KV Store Data

Get data from a KV store collection

ParameterRequiredTypeDescription
Collection collectionYestext

Get a saved search by name

ParameterRequiredTypeDescription
Name nameYestext

Get Search Results

Get results of a search job

ParameterRequiredTypeDescription
Search Id search_idYestext

Tips

  • Poll job ID. Returns rows.

Get Search Status

Get status of a search job

ParameterRequiredTypeDescription
Search Id search_idYestext

Get Server Info

Get server information

No input parameters.


Insert KV Store Data

Insert data into a KV store collection

ParameterRequiredTypeDescription
Collection collectionYestext

List Alerts

List fired alerts

No input parameters.

Tips

  • Active alerts + their schedules.

List Apps

List installed apps

No input parameters.


List Dashboards

List all dashboards

No input parameters.

Tips

  • User + app-scoped dashboards.

List Indexes

List all indexes

No input parameters.


List Inputs

List all data inputs

No input parameters.


List KV Store Collections

List KV store collections

No input parameters.


List Saved Searches

List all saved searches

No input parameters.


Run a oneshot search that returns results immediately

ParameterRequiredTypeDescription
Search searchNotext
Earliest Time earliest_timeNotext
Latest Time latest_timeNotext
Output Mode output_modeNotext

Create a search job

ParameterRequiredTypeDescription
Search searchNotext
Earliest Time earliest_timeNotext
Latest Time latest_timeNotext
Output Mode output_modeNotext

Submit Event

Send raw event data to an index

No input parameters.


FAQ

SPL?
Splunk Processing Language – Splunk's powerful query language. 'index=main sourcetype=access | stats count by status'.

Related connectors

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.