Splunk's API is RESTful
Contents
Splunk's API is RESTful
Splunk's API is RESTful, which means it uses HTTP requests to interact with resources within Splunk. You can use the REST API to configure and manage a Splunk instance, create and run searches in Splunk, or create your own applications that interact with Splunk.
You can use any language or tool that supports HTTP calls to access the Splunk REST API.
In Splunk 4.2.3, the [Documentation:Splunk:RESTAPI:RESTintro|Splunk REST API Reference]] became available, detailing all available REST endpoints. Splunk for Developers became available at the same time, providing an Overview of the REST API, as well as tutorials, examples, and how-tos.
About the Splunk REST API Reference
The Splunk REST API Reference is now available as a separate manual. Highlights of the Splunk REST API Reference include:
- Overview page describing the contents of the reference
- Index page to all publicly available endpoints
- Series of topics on using the REST API
- Creating searches using the REST API
The Splunk REST API Reference also includes several examples:
- Authenticating yourself to the Splunk server to access Splunk endpoints
- Accessing and updating Splunk configurations
- Some basic examples using the Splunk REST API
- Create a search and retrieve the results
- The REST API Overview at Spunk for Developers provides additional tutorials and examples
This documentation applies to the following versions of Splunk: 4.3 , 4.3.1 , 4.3.2 View the Article History for its revisions.