ACS CLI Tasks

Bulk operations and ACS feature reference

Bulk Operations — add entries below or upload a file, then generate.

Operation Settings
Generate indexes.conf stanzas. Upload a CSV/Excel with: Index Name, Datatype, Retention, etc.
Upload & Generate

Drag & Drop Files

or click to select CSV / Excel

Conf Generator

Generate Splunk .conf file stanzas

Configuration

Set stanza name (sourcetype) and optional parsing options.

Generated Stanza
props.conf
# Configuration will appear here...

Create Splunk App

Package multiple conf files and metadata into a Splunk app (.zip / .spl)

[]
access = read : [ * ], write : [ admin ]
export = none

Included as metadata/local.meta in the package.

Supported formats: .spl, .zip, .tar, .tar.gz, .tgz. Use .spl to install via Splunk UI or splunk install app.

File Path Guide

Cross-platform directory and CLI reference

Install type
Full Directory List
Target Linux / Mac Path Windows Path
Installation Directory/opt/splunkC:\Program Files\Splunk
Configuration Files/opt/splunk/etcC:\Program Files\Splunk\etc
Apps Directory/opt/splunk/etc/appsC:\Program Files\Splunk\etc\apps
Logs Directory/opt/splunk/var/log/splunkC:\Program Files\Splunk\var\log\splunk
Indexes Directory/opt/splunk/var/lib/splunkC:\Program Files\Splunk\var\lib\splunk
Splunk Bin Directory/opt/splunk/binC:\Program Files\Splunk\bin
Deployment Server Config Directory/opt/splunk/etc/deployment-appsC:\Program Files\Splunk\etc\deployment-apps
Search Head Directory/opt/splunk/etc/searchheadsC:\Program Files\Splunk\etc\searchheads
Cluster Configuration Directory/opt/splunk/etc/master-appsC:\Program Files\Splunk\etc\master-apps
Saved Searches Directory/opt/splunk/etc/savedsearchesC:\Program Files\Splunk\etc\savedsearches
Authentication Configuration Directory/opt/splunk/etc/authC:\Program Files\Splunk\etc\auth
SSL Certificate Directory/opt/splunk/etc/auth/certsC:\Program Files\Splunk\etc\auth\certs
Props.conf Directory/opt/splunk/etc/system/localC:\Program Files\Splunk\etc\system\local
Index Configuration Directory/opt/splunk/etc/system/local/indexes.confC:\Program Files\Splunk\etc\system\local\indexes.conf
Deployment Server Apps Directory/opt/splunk/etc/deployment-appsC:\Program Files\Splunk\etc\deployment-apps
Inputs Configuration Directory/opt/splunk/etc/system/local/inputs.confC:\Program Files\Splunk\etc\system\local\inputs.conf
Transformations Directory/opt/splunk/etc/system/local/transforms.confC:\Program Files\Splunk\etc\system\local\transforms.conf
Dashboards Directory/opt/splunk/etc/apps/<app>/default/data/ui/viewsC:\Program Files\Splunk\etc\apps\<app>\default\data\ui\views
Splunk Home (SPLUNK_HOME)/opt/splunkC:\Program Files\Splunk
User Directories/opt/splunk/etc/users/<user>C:\Program Files\Splunk\etc\users\<user>
Deployment Clients Directory/opt/splunk/etc/deployment-clientsC:\Program Files\Splunk\etc\deployment-clients
KV Store Directory/opt/splunk/var/lib/splunk/kvstoreC:\Program Files\Splunk\var\lib\splunk\kvstore
KV Store Summary Directory/opt/splunk/var/lib/splunk/kvstore/summaryC:\Program Files\Splunk\var\lib\splunk\kvstore\summary
Fishbucket (checkpoint) Directory/opt/splunk/var/lib/splunk/fishbucketC:\Program Files\Splunk\var\lib\splunk\fishbucket
Splunkd Log File/opt/splunk/var/log/splunk/splunkd.logC:\Program Files\Splunk\var\log\splunk\splunkd.log
License Directory/opt/splunk/etc/licensesC:\Program Files\Splunk\etc\licenses
Introspection (internal metrics) Directory/opt/splunk/var/lib/splunk/introspectionC:\Program Files\Splunk\var\lib\splunk\introspection
User Interface Directory/opt/splunk/share/splunk/search_mrsparkleC:\Program Files\Splunk\share\splunk\search_mrsparkle
Splunk Python Directory/opt/splunk/Python-<version>C:\Program Files\Splunk\Python-<version>
Splunk Apps Bin Directory/opt/splunk/etc/apps/<appname>/binC:\Program Files\Splunk\etc\apps\<appname>\bin
Splunk App Local Directory/opt/splunk/etc/apps/<appname>/localC:\Program Files\Splunk\etc\apps\<appname>\local
Splunk App Metadata Directory/opt/splunk/etc/apps/<appname>/metadataC:\Program Files\Splunk\etc\apps\<appname>\metadata
Splunk App Static Directory/opt/splunk/etc/apps/<appname>/staticC:\Program Files\Splunk\etc\apps\<appname>\static
Splunk App Default Directory/opt/splunk/etc/apps/<appname>/defaultC:\Program Files\Splunk\etc\apps\<appname>\default
Btool Master Class
ActionLinux / Mac CommandWindows Command
Check config (typos / validity)./splunk btool checksplunk.exe btool check
List all conf types./splunk btool --helpsplunk.exe btool --help
Props (sourcetype / parsing)./splunk btool props list [--debug]splunk.exe btool props list [--debug]
Transforms./splunk btool transforms list [--debug]splunk.exe btool transforms list [--debug]
Indexes./splunk btool indexes list [--app=search]splunk.exe btool indexes list [--app=search]
Inputs./splunk btool inputs list [--debug]splunk.exe btool inputs list [--debug]
Outputs (forwarding)./splunk btool outputs list [--debug]splunk.exe btool outputs list [--debug]
Server./splunk btool server list [--debug]splunk.exe btool server list [--debug]
Web (HTTP / SSL)./splunk btool web list [--debug]splunk.exe btool web list [--debug]
Limits./splunk btool limits list [--debug]splunk.exe btool limits list [--debug]
Authentication./splunk btool authentication list [--debug]splunk.exe btool authentication list [--debug]
Authorize (roles)./splunk btool authorize list [--debug]splunk.exe btool authorize list [--debug]
Deployment client./splunk btool deploymentclient list [--debug]splunk.exe btool deploymentclient list [--debug]
Saved searches (reports/alerts)./splunk btool savedsearches list [--user=admin]splunk.exe btool savedsearches list [--user=admin]
Lookups./splunk btool lookups list [--debug]splunk.exe btool lookups list [--debug]
Fields./splunk btool fields list [--debug]splunk.exe btool fields list [--debug]
Tags./splunk btool tags list [--debug]splunk.exe btool tags list [--debug]
Event types./splunk btool eventtypes list [--debug]splunk.exe btool eventtypes list [--debug]
Macros./splunk btool macros list [--debug]splunk.exe btool macros list [--debug]
Alert actions./splunk btool alert_actions list [--debug]splunk.exe btool alert_actions list [--debug]
REST map (custom endpoints)./splunk btool restmap list [--debug]splunk.exe btool restmap list [--debug]
Search stanza in inputs./splunk btool inputs list --debug | grep "monitor"splunk.exe btool inputs list --debug | findstr "monitor"
Fishbucket & Checkpoint
ActionLinux / Mac Command or PathWindows Command or Path
Fishbucket directory (checkpoint DB)/opt/splunk/var/lib/splunk/fishbucketC:\Program Files\Splunk\var\lib\splunk\fishbucket
Reset checkpoint for one file (btprobe)./splunk cmd btprobe -d var/lib/splunk/fishbucket/splunk_private_db --file /path/to/file --resetsplunk.exe cmd btprobe -d var\lib\splunk\fishbucket\splunk_private_db --file C:\path\to\file --reset
Clean all fishbucket (stop first)./splunk stop then rm -rf var/lib/splunk/fishbucket/* then ./splunk startsplunk.exe stop then delete var\lib\splunk\fishbucket\* then splunk.exe start
Inspect fishbucket DB (btprobe list)./splunk cmd btprobe -d var/lib/splunk/fishbucket/splunk_private_db --listsplunk.exe cmd btprobe -d var\lib\splunk\fishbucket\splunk_private_db --list
Service Commands
ActionLinux / Mac CommandWindows Command
Start Splunk./splunk startsplunk.exe start
Restart./splunk restartsplunk.exe restart
Stop./splunk stopsplunk.exe stop
Status./splunk statussplunk.exe status
Diag./splunk diagsplunk.exe diag
Show version./splunk versionsplunk.exe version
Reload DS./splunk reload deploy-serversplunk.exe reload deploy-server
Reload (configs)./splunk reloadsplunk.exe reload
Clean event data (index)./splunk clean eventdata -index <name>splunk.exe clean eventdata -index <name>
Enable boot-start./splunk enable boot-startsplunk.exe enable boot-start
Disable boot-start./splunk disable boot-startsplunk.exe disable boot-start
List forward-server (outputs)./splunk list forward-serversplunk.exe list forward-server

cURL Generator

Build cURL commands for ACS and REST API requests

Configuration
URL
Request

ACS base path: adminconfig/v2. Replace {placeholders} in the generated URL with your values.

Text Editor

Multi-pane clipboard: combine, find/replace, copy, download

Source panes
Combined output

Utilities

SPL formatter, Base64, time range, and config converters

Format Search Processing Language (SPL) with indentation for readability, or minify to a single line.

Format (indent): Adds line breaks and indentation so the search is easier to read. Minify: Removes extra whitespace and puts the whole search on one line (e.g. for sharing or APIs).


                        
Time range to SPL

Build earliest/latest time range values for Splunk searches (e.g. last 24 hours, custom range).


                            

Quick Reference

ACS commands, SPL examples, and endpoints

ACS Feature Reference
ACS Feature Command / Endpoint
Configure IP allow lists (IPv4)acs ip-allowlist
Configure IP allow lists (IPv6)acs ip-allowlist-v6
Configure outbound ports (IPv4)acs outbound-port
Configure outbound ports (IPv6)acs outbound-port-v6
Export appsacs apps export
Manage app permissionsacs permissions apps
Manage authentication tokensacs token
Manage HEC tokensacs hec-token
Manage indexesacs indexes
Manage limits.confacs limits
Manage maintenance windowsacs maintenance-windows
Manage private appsacs apps (install, list, describe, uninstall)
Manage Splunkbase appsacs apps (install splunkbase, update, list, uninstall)
Manage restartsacs restart
Manage rolesacs roles
Manage usersacs users
Retry failed operationsacs deployment retry
View capabilitiesacs capabilities
DDSS self-storage locationsacs indexes self-storage-locations
Unified Identity (Observability)acs observability pair
Bulk operation commands
Bulk operation Command
HEC tokensacs hec-token bulk-create / bulk-update / bulk-delete --file file.json
Indexesacs indexes bulk-create / bulk-update / bulk-delete --file file.json
Install Splunkbase appsacs apps bulk-install splunkbase --file apps.json
Uninstall appsacs apps bulk-uninstall --file file.json
Export appsacs apps export --file=apps_to_export.json
Private apps (vet & install)acs apps bulk-install private --package-src-dir path/to/packages --acs-legal-ack=Y
App permissionsacs permissions apps bulk-update
Common SPL searches
Purpose Example
Last N events (any index)index=* | head 20
Count by fieldindex=main | stats count by sourcetype
Time range (last 24h)index=main earliest=-24h latest=now
Table specific fieldsindex=main | table _time host source sourcetype
Search string in rawindex=main "error" OR "failure"
Rename field| eval new_name = old_field
Filter with where| where count > 10
Dedup by field| dedup host
Sort| sort - _time
Rex (extract with regex)| rex field=_raw "<(?<id>[^>]+)>"
Lookup| lookup my_lookup key OUTPUT value
Subsearchindex=main [ search index=summary | head 1 ]
Index Migration (Rest / DB Inspect)
PurposeSPL
REST Command on CM
Run connected via Cluster Master
| rest splunk_server=local /services/cluster/manager/buckets f=title f=primaries_by_site* timeout=0
| rex field=title "(?<index>[^~]+)~(?<bid>.*)"
| rename primaries_by_site.site0 AS source_guid
| table index, bid, source_guid, dest_index
DB Inspect on SH
Run on Search Head (or CM)
| dbinspect index=*
| search NOT state=hot
| dedup bucketId
| rex field=buckedId "(?<index>[^~]+)~(?<bid>.*)"
| table index
| dedup index
Time modifiers (SPL)
Modifier Meaning
earliest=-15mLast 15 minutes
earliest=-1hLast 1 hour
earliest=-24hLast 24 hours
earliest=-7dLast 7 days
earliest=-30dLast 30 days
latest=nowUp to current time
earliest=0All time (use with care)
Props & Transforms snippets
Attribute / FileExample
props: LINE_BREAKERLINE_BREAKER = ([\r\n]+)
props: TIME_FORMATTIME_FORMAT = %Y-%m-%dT%H:%M:%S.%3N%z
props: MAX_EVENTSMAX_EVENTS = 256
props: rexrex = (?<field>regex)
props: REPORTREPORT-extract = my_extract (stanza in transforms)
props: EXTRACTEXTRACT-foo = ^(?<bar>.+?) in
transforms: REGEXREGEX = (?<key>\w+)=(?<value>[^\s]+)
transforms: FORMATFORMAT = key::$1 value::$2
transforms: DEST_KEYDEST_KEY = MetaData:Source
transforms: SOURCE_KEYSOURCE_KEY = _raw
SPL commands (stats, eval, transform)
Command Use Example
statsAggregate / group| stats count, sum(bytes) by host
evalCompute fields| eval ratio = success / total
lookupEnrich from table| lookup my_lookup host OUTPUT env
joinCorrelate two searches| join type=left host [ search index=metrics ]
transactionGroup events| transaction host maxspan=5m
binBucket time/values| bin _time span=1h
chartPivot to chart| chart count by host over _time
appendCombine result sets| append [ search index=other ]
mapRun subsearch per row| map search="search index=main host=$host$"
foreachLoop over fields| foreach col* [ eval sum_<<FIELD>> = '<<FIELD>>' ]
mvexpandOne row per MV value| mvexpand mv_field
makemvSplit to multivalue| makemv delim="," field=tags
Splunk REST API (search & auth)
Purpose Endpoint / notes
Create search job (async)POST /services/search/jobssearch=..., output_mode=json
Oneshot (blocking)POST /services/search/jobsexec_mode=oneshot, search=...
Export results (stream)POST /servicesNS/<user>/<app>/search/jobs/exportsearch=..., output_mode=csv|json|xml
Job resultsGET /services/search/jobs/<sid>/resultsoutput_mode=json_rows
Job controlDELETE /services/search/jobs/<sid> (cancel), GET .../control (pause/unpause)
List jobsGET /services/search/jobscount=0 for all
Auth (token)POST /services/auth/loginusername, password; or Authorization: Bearer <token>
HEC (ingest)POST /services/collector/eventAuthorization: Splunk <hec_token>, JSON body
indexes.conf & inputs.conf
File / attribute Example
indexes: homePath, coldPath, thawedPathhomePath = $SPLUNK_DB/<INDEX>/db (and cold/thawed)
indexes: maxTotalDataSizeMBmaxTotalDataSizeMB = 500000
indexes: frozenTimePeriodInSecsfrozenTimePeriodInSecs = 7776000 (90d)
inputs: monitor (file)[monitor:///var/log/app/*.log]sourcetype=..., index=...
inputs: batch (file)[batch:///path] — read file once
inputs: script[script://./bin/myscript.sh]interval=60, sourcetype=...
inputs: TCP / UDP[tcp://1514], [udp://514]sourcetype=..., index=...
inputs: HTTP Event CollectorConfigure in UI or inputs.conf (http); token in limits.conf or ACS
Runbook placeholders

Copy these into runbooks and docs; replace with real values for each environment.

Splunk Cloud: ACS CLI · SPL Search Reference · REST API Reference

Copied!