Add fields to collection
Action ID:tools.splunk.add_kv_fields
Add field definitions to a KV Store collection in Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#post-9
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Name of the KV Store collection to add fields to. Must be unique and
contain only alphanumeric characters, underscores, and hyphens.
List of field definitions to add. Each field requires name and type.
Supported types: array, number, bool, string, cidr, time
Example: [{“name”: “username”, “type”: “string”}, {“name”: “age”, “type”: “number”}]
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Batch save KV entries
Action ID:tools.splunk.batch_save_kv_entries
Insert or update multiple entries in a Splunk KV Store collection in a single request. If an entry includes a _key that matches an existing document, it is updated; otherwise a new document is created. Processing stops on the first failure.
Reference: https://help.splunk.com/en/splunk-cloud-platform/leverage-rest-apis/rest-api-reference/10.0.2503/kv-store-endpoints/kv-store-endpoint-descriptions#ariaid-title16
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
List of documents to save. Each document is a dict of field-value pairs.
Include a _key field to update an existing document; omit it to create a new one
(Splunk auto-generates the key). Maximum 1000 documents per request (Splunk default).
Example: [{“username”: “john”, “email”: “john@example.com”, “active”: true}, {“username”: “jane”, “email”: “jane@example.com”, “active”: false}]
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Create KV collection
Action ID:tools.splunk.create_kv_collection
Create a new KV Store collection in Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#post-9
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Name of the KV Store collection. Must be unique and contain only
alphanumeric characters, underscores, and hyphens.
Splunk app context where the collection will be created (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Create KV entry
Action ID:tools.splunk.create_kv_entry
Create a new entry in a Splunk KV Store collection.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#post-2
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Key-value pairs to store in the collection. The _key field is automatically
generated by Splunk if not provided.
Example: {“username”: “john”, “email”: “john@example.com”, “active”: true}
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Delete KV collection
Action ID:tools.splunk.delete_kv_collection
Delete a KV Store collection from Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#delete-0
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Delete KV entry
Action ID:tools.splunk.delete_kv_entry
Delete an entry from a KV Store collection in Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#delete-1
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
The _key value of the entry to delete from the collection.
Example: “5f3a1b2c3d4e5f6a7b8c9d0e”
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Discover fields
Action ID:tools.splunk.discover_fields
Discover fields in Splunk data using the fieldsummary command with statistics and sample values.
Reference: https://help.splunk.com/en?resourceId=Splunk_SearchReference_Fieldsummary&version=splunk-9_4
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089).Default:
null.Get KV collection
Action ID:tools.splunk.get_kv_collection
Get configuration details for a specific KV Store collection from Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#get-5
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Get KV entry
Action ID:tools.splunk.get_kv_entry
Get a specific entry from a KV Store collection in Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#get-7
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
The _key value of the entry to retrieve from the collection.
Example: “5f3a1b2c3d4e5f6a7b8c9d0e”
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.List data models
Action ID:tools.splunk.list_data_models
List all data models on the Splunk server using native Splunk search.
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089).Default:
null.List field extractions
Action ID:tools.splunk.list_field_extractions
List all configured field extraction rules using a simple Splunk query.
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089).Default:
null.List indexes
Action ID:tools.splunk.list_indexes
List all indexes on the Splunk server using native Splunk search.
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089).Default:
null.List KV collections
Action ID:tools.splunk.list_kv_collections
List all KV Store collections in Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#get-4
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Search query to filter collections.
Example: “name=whitelist” to find collections with “whitelist” in the name.Default:
"".List KV entries
Action ID:tools.splunk.list_kv_entries
List entries in a KV Store collection from Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#get-6
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.MongoDB-style query to filter entries.
Supported operators:
- Conditional: gte, lte, $ne
- Regex: $regex
- Logical: or, $not Examples:
- {“title”: “Item”} - Find entries where title equals “Item”
- {“price”: {“$gt”: 5}} - Find entries where price > 5
- {“ip”: {“$regex”: “192.168.1.*”}} - Find entries matching IP pattern
{}.Include entries from both specified owner and “nobody” user.Default:
false.List sourcetypes
Action ID:tools.splunk.list_sourcetypes
List all defined sourcetypes on the Splunk server.
Reference: https://help.splunk.com/en?resourceId=Splunk_RESTREF_RESTsearch&version=splunk-9_4
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089).Default:
null.Search events
Action ID:tools.splunk.search_events
Search events from Splunk.
Reference: https://help.splunk.com/en?resourceId=Splunk_RESTREF_RESTsearch&version=splunk-9_4#search.2Fjobs
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk (Splunk Query Language) search query. You MUST start the query with
search, e.g. search index=main | head 10Splunk base URL (e.g. https://localhost:8089).Default:
null.Submit HEC event
Action ID:tools.splunk.submit_hec_event
Submit an event to Splunk using the HTTP Event Collector (HEC). Uses HEC token authentication.
Reference: https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/9.4/get-data-with-http-event-collector/format-events-for-http-event-collector
Secrets
Required secrets:splunk_hec: required valuesSPLUNK_HEC_TOKEN.
Input fields
Event data to send to Splunk. Can contain any key-value pairs.
Example: {“action”: “login”, “username”: “john”, “ip”: “192.168.1.100”}
Splunk HEC endpoint URL (e.g. https://localhost:8088 or https://tracecat.splunkcloud.com:8088).Default:
null.Splunk index to send the event to. If not specified, uses the default index configured for the HEC token.Default:
null.Update KV entry
Action ID:tools.splunk.update_kv_entry
Update an existing entry in a KV Store collection in Splunk.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions#post-12
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
The _key value of the entry to update in the collection.
Example: “5f3a1b2c3d4e5f6a7b8c9d0e”
Fields to update in the entry. Only specified fields will be updated.
Example: {“status”: “completed”, “updated_at”: “2024-01-15”}
Splunk app context where the collection resides (e.g. “search” for default).Default:
"search".Splunk base URL (e.g. https://localhost:8089 or https://tracecat.splunkcloud.com:8089).Default:
null.Upload CSV to KV Collection
Action ID:tools.splunk.upload_csv_to_kv_collection
Download a CSV file and upload its rows to a Splunk KV Store collection with create, append, or override modes.
Reference: https://help.splunk.com/en/splunk-enterprise/rest-api-reference/9.4/kv-store-endpoints/kv-store-endpoint-descriptions
Secrets
Required secrets:splunk: required valuesSPLUNK_API_KEY.
Input fields
Splunk base URL (e.g. https://localhost:8089 or https://example.splunkcloud.com:8089). If not provided, falls back to the workspace variable
splunk.base_url.Default: null.Optional HTTP headers for downloading the CSV (e.g. Authorization).Default:
null.create: new collection, error if it exists. append: add to existing collection, error if missing. override: replace existing collection if present.Default:
"create".Allowed values: create, append, override.