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
- Go to Organization > Connectors and find Splunk.
- Click Enable and choose which tools to allow.
- 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.
| Tool | What it does |
|---|---|
get_alert_action | Get configuration for one alert action by name, e.g. 'email'. |
get_app | Get an installed app by name, including its version and label. |
get_dashboard | Get a dashboard/view by name, including its XML/definition. |
get_eventtype | Get an event type by name, including its defining search. |
get_field_extraction | Get a field extraction by name, including its type and regex/stanza. |
get_fired_alerts_for_search | List the triggered-alert records for one saved search by name; each entry's name is the alert id delete_fired_alerts takes. |
get_hec_token | Get an HTTP Event Collector token by name, including its token value and index settings. |
get_index | Get a data index by name, including retention and size settings. |
get_kvstore_collection | Get a KV store collection definition by name in a namespace (owner/app). |
get_kvstore_record | Get a single KV store document by its _key. |
get_lookup | Get a lookup-table definition by name. |
get_macro | Get a search macro by name, including its definition. |
get_role | Get a Splunk role by name, including its capabilities and index access. |
get_saved_search | Get a saved search by name, including its SPL and schedule. |
get_saved_search_history | List the past search jobs dispatched from a saved search, by name. |
get_search_events | Get the raw matching events (pre-transformation) of a search job by its sid, with optional time-range and field filters. |
get_search_job | Get the status and metadata of a search job by its id (sid). |
get_search_results | Get the transformed results of a completed search job by its sid. |
get_search_results_preview | Get preview (partial) results of a still-running search job by its sid. |
get_search_summary | Get the field summary (per-field statistics) for a search job by its sid. |
get_search_timeline | Get the event-timeline buckets for a search job by its sid. |
get_server_health | Get the splunkd health report (overall green/yellow/red and red/yellow feature counts). |
get_server_info | Get deployment server info: version, build, GUID, OS, and hardware. |
get_server_settings | Get deployment server settings: ports, SPLUNK_DB path, SSL, and session timeout. |
get_tag | Get a tag by name, including the field::value pairs it maps. |
get_user | Get a Splunk user by username, including roles and email. |
list_alert_actions | List available alert actions (email, webhook, script, ...). |
list_apps | List installed apps. |
list_auth_tokens | List authentication (JWT) tokens. |
list_capabilities | List all capabilities available on the deployment (the permission atoms roles are built from). |
list_dashboards | List dashboards/views. |
list_eventtypes | List event types. |
list_field_extractions | List field extractions (EXTRACT/REPORT). |
list_fired_alerts | List fired-alert groups (one per saved search that has triggered). |
list_hec_tokens | List HTTP Event Collector (HEC) tokens/inputs. |
list_indexes | List data indexes. |
list_kvstore_collections | List KV store collection definitions in a namespace (owner/app). |
list_lookups | List lookup-table definitions. |
list_macros | List search macros. |
list_roles | List Splunk roles. |
list_saved_searches | List saved searches (reports and alerts). |
list_search_jobs | List search jobs on the deployment. |
list_server_messages | List system bulletin messages (banner notices such as disk-space or crash warnings). |
list_tags | List tags defined in the search app. |
list_users | List Splunk user accounts. |
query_kvstore_records | Query documents in a KV store collection with an optional Mongo-style filter, field projection, and sort. |
validate_credential | Validate Splunk credentials and connectivity by fetching server info. |
Write (10)
Create or send data.
| Tool | What it does |
|---|---|
create_auth_token | Create an authentication (JWT) token for a user. |
create_eventtype | Create an event type. |
create_field_extraction | Create a field extraction. |
create_hec_token | Create an HTTP Event Collector token. |
create_index | Create a data index. |
create_kvstore_collection | Create a KV store collection in a namespace (owner/app). |
create_lookup | Create a lookup-table definition. |
create_macro | Create a search macro. |
create_saved_search | Create a saved search. |
insert_kvstore_record | Insert one document into a KV store collection (JSON body). |
Delete or overwrite (26)
Remove or replace existing data.
| Tool | What it does |
|---|---|
batch_save_kvstore_records | Insert or update many KV store documents in one call (JSON array body); include '_key' to update an existing document. |
control_search_job | Control a running search job: pause, unpause, finalize, cancel, touch, setttl, setpriority, save, or unsave. |
create_search_job | Dispatch a new search job from SPL. |
delete_auth_token | Delete (revoke) an authentication token by owner username. |
delete_eventtype | Delete an event type by name. |
delete_field_extraction | Delete a field extraction by name. |
delete_fired_alerts | Delete one scheduler-fired alert record by its alert id (ids start with 'scheduler__'; Splunk rejects records from a manual dispatch). |
delete_hec_token | Delete an HTTP Event Collector token by name. |
delete_index | Delete a data index by name. |
delete_kvstore_collection | Delete a KV store collection (and all its records) by name in a namespace. |
delete_kvstore_record | Delete a single KV store document by its _key. |
delete_kvstore_records | Delete documents from a KV store collection matching an optional filter. |
delete_lookup | Delete a lookup-table definition by name. |
delete_macro | Delete a search macro by name. |
delete_saved_search | Delete a saved search by name. |
delete_search_job | Delete (cancel and remove) a search job by its id (sid). |
dispatch_saved_search | Run a saved search now, creating a new search job. |
export_search | Run SPL and stream back matching results in one call without persisting a job. |
update_eventtype | Update an event type's search, priority, or disabled state by name. |
update_hec_token | Update an HTTP Event Collector token's index, sourcetype, or disabled state by name. |
update_index | Update a data index's size, retention, or disabled state by name. |
update_kvstore_collection | Update a KV store collection's field types or acceleration by name in a namespace. |
update_kvstore_record | Replace a KV store document by its _key with a new document (JSON body). |
update_lookup | Update a lookup-table definition's file, collection, or field list by name. |
update_macro | Update a search macro's definition or arguments by name. |
update_saved_search | Update a saved search's SPL, schedule, or alert settings by name. |