Available Splunk APIs

Rachel Shanthi Bijja

Updated November 25, 2024 17:23

When you configure an export, import, or other type of flow step using the prebuilt Splunk connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Splunk API documentation. *You can also create a composite endpoint for this application in HTTP mode.

Resource	API endpoint	Export	Import
Search	Get details of all current searches	X
	Get `{search_id}` search results	X
	Get the `getFieldsAndStats` output of the events to-date, for the `search_id` search	X
	Get a list of words or descriptions for possible auto-complete terms	X
	Start a new search and return the search ID (sid)		X
Alerts	Access a list of alert actions	X
	Access all fired alerts	X
	Access specific fired alert	X
Catalog	List metric names	X
	List dimension names	X
	List values for given dimensions	X
DataModel	Access information about data models	X
	Access information about a data model	X
	Access information about data models		X
	Access information about a data model		X
Indexes	Access logical drive information	X
Indexes	Access information for a logical drive	X
Data	Manage specific data index		X
Messages	Manage system messages		X
Messages	Manage specific system message		X