Skip to main content

Splunk

Splunk Enterprise connector for running searches, managing saved searches and alerts, indexes, HTTP Event Collector tokens, lookups, macros, event types, field extractions, the KV store, users, roles, dashboards, and server administration.

Categories: Analytics, Monitoring, Security, Data

Set up​

Splunk connects with credentials from your Splunk account. Have these values ready:

  • Management URL
  • Verify SSL (optional)
  • Authentication token
  1. Go to Organization > Connectors and find Splunk.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Splunk offers 83 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (47)​

View and search information without changing it.

ToolWhat it does
get_alert_actionGet configuration for one alert action by name, e.g. 'email'.
get_appGet an installed app by name, including its version and label.
get_dashboardGet a dashboard/view by name, including its XML/definition.
get_eventtypeGet an event type by name, including its defining search.
get_field_extractionGet a field extraction by name, including its type and regex/stanza.
get_fired_alerts_for_searchList the triggered-alert records for one saved search by name; each entry's name is the alert id delete_fired_alerts takes.
get_hec_tokenGet an HTTP Event Collector token by name, including its token value and index settings.
get_indexGet a data index by name, including retention and size settings.
get_kvstore_collectionGet a KV store collection definition by name in a namespace (owner/app).
get_kvstore_recordGet a single KV store document by its _key.
get_lookupGet a lookup-table definition by name.
get_macroGet a search macro by name, including its definition.
get_roleGet a Splunk role by name, including its capabilities and index access.
get_saved_searchGet a saved search by name, including its SPL and schedule.
get_saved_search_historyList the past search jobs dispatched from a saved search, by name.
get_search_eventsGet the raw matching events (pre-transformation) of a search job by its sid, with optional time-range and field filters.
get_search_jobGet the status and metadata of a search job by its id (sid).
get_search_resultsGet the transformed results of a completed search job by its sid.
get_search_results_previewGet preview (partial) results of a still-running search job by its sid.
get_search_summaryGet the field summary (per-field statistics) for a search job by its sid.
get_search_timelineGet the event-timeline buckets for a search job by its sid.
get_server_healthGet the splunkd health report (overall green/yellow/red and red/yellow feature counts).
get_server_infoGet deployment server info: version, build, GUID, OS, and hardware.
get_server_settingsGet deployment server settings: ports, SPLUNK_DB path, SSL, and session timeout.
get_tagGet a tag by name, including the field::value pairs it maps.
get_userGet a Splunk user by username, including roles and email.
list_alert_actionsList available alert actions (email, webhook, script, ...).
list_appsList installed apps.
list_auth_tokensList authentication (JWT) tokens.
list_capabilitiesList all capabilities available on the deployment (the permission atoms roles are built from).
list_dashboardsList dashboards/views.
list_eventtypesList event types.
list_field_extractionsList field extractions (EXTRACT/REPORT).
list_fired_alertsList fired-alert groups (one per saved search that has triggered).
list_hec_tokensList HTTP Event Collector (HEC) tokens/inputs.
list_indexesList data indexes.
list_kvstore_collectionsList KV store collection definitions in a namespace (owner/app).
list_lookupsList lookup-table definitions.
list_macrosList search macros.
list_rolesList Splunk roles.
list_saved_searchesList saved searches (reports and alerts).
list_search_jobsList search jobs on the deployment.
list_server_messagesList system bulletin messages (banner notices such as disk-space or crash warnings).
list_tagsList tags defined in the search app.
list_usersList Splunk user accounts.
query_kvstore_recordsQuery documents in a KV store collection with an optional Mongo-style filter, field projection, and sort.
validate_credentialValidate Splunk credentials and connectivity by fetching server info.

Write (10)​

Create or send data.

ToolWhat it does
create_auth_tokenCreate an authentication (JWT) token for a user.
create_eventtypeCreate an event type.
create_field_extractionCreate a field extraction.
create_hec_tokenCreate an HTTP Event Collector token.
create_indexCreate a data index.
create_kvstore_collectionCreate a KV store collection in a namespace (owner/app).
create_lookupCreate a lookup-table definition.
create_macroCreate a search macro.
create_saved_searchCreate a saved search.
insert_kvstore_recordInsert one document into a KV store collection (JSON body).

Delete or overwrite (26)​

Remove or replace existing data.

ToolWhat it does
batch_save_kvstore_recordsInsert or update many KV store documents in one call (JSON array body); include '_key' to update an existing document.
control_search_jobControl a running search job: pause, unpause, finalize, cancel, touch, setttl, setpriority, save, or unsave.
create_search_jobDispatch a new search job from SPL.
delete_auth_tokenDelete (revoke) an authentication token by owner username.
delete_eventtypeDelete an event type by name.
delete_field_extractionDelete a field extraction by name.
delete_fired_alertsDelete one scheduler-fired alert record by its alert id (ids start with 'scheduler__'; Splunk rejects records from a manual dispatch).
delete_hec_tokenDelete an HTTP Event Collector token by name.
delete_indexDelete a data index by name.
delete_kvstore_collectionDelete a KV store collection (and all its records) by name in a namespace.
delete_kvstore_recordDelete a single KV store document by its _key.
delete_kvstore_recordsDelete documents from a KV store collection matching an optional filter.
delete_lookupDelete a lookup-table definition by name.
delete_macroDelete a search macro by name.
delete_saved_searchDelete a saved search by name.
delete_search_jobDelete (cancel and remove) a search job by its id (sid).
dispatch_saved_searchRun a saved search now, creating a new search job.
export_searchRun SPL and stream back matching results in one call without persisting a job.
update_eventtypeUpdate an event type's search, priority, or disabled state by name.
update_hec_tokenUpdate an HTTP Event Collector token's index, sourcetype, or disabled state by name.
update_indexUpdate a data index's size, retention, or disabled state by name.
update_kvstore_collectionUpdate a KV store collection's field types or acceleration by name in a namespace.
update_kvstore_recordReplace a KV store document by its _key with a new document (JSON body).
update_lookupUpdate a lookup-table definition's file, collection, or field list by name.
update_macroUpdate a search macro's definition or arguments by name.
update_saved_searchUpdate a saved search's SPL, schedule, or alert settings by name.
⌘J