REST API Reference Manual

 


What's in this manual

NOTE - Splunk version 4.x reached its End of Life on October 1, 2013. Please see the migration information.

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.

What's in this manual

Introduction to Splunk's REST API

About the Splunk REST API
Basic introduction to Splunk RESTful services. Lists API endpoints new with Splunk 4.2.3.

How to use the Splunk REST API
Describes HTTP operations supported.

Splunk's Atom Feed response to REST operations
Details the structure of REST responses to operations.

Accessing Splunk resources
Details how to access Splunk services. Includes a section describing Splunk's layering of resources and which endpoints to use to access them.

Accessing and updating Splunk configurations
Shows the endpoints to use to access and update Splunk configuration files.

Examples using the Splunk REST API
Some examples of common Splunk REST API calls.

Additional examples and tutorials
Links to examples and tutorials available from the Splunk Dev Portal.

REST API Reference

Groups Splunk endpoints according to the following categories:

Access control
Authorize and authenticate users.

Applications
Install applications and application templates into a Splunk instance.

Configuration
Access and modify Splunk configuration files and settings.

Deployment
Manage deployment servers and clients.

Indexes
Create and manage data indexes.

Inputs
Manage data sent to Splunk servers.

Knowledge
Define data configurations indexed and searched by Splunk.

Licensing
Manage licensing configurations.

Outputs
Manage the configuration of data sent from Splunk forwarders.

Search
Manage searches, alerts, and view objects generated from searches.

System
Manage Splunk server configurations.

REST API Endpoints
Alphabetical list of all Splunk REST API endpoints.

This documentation applies to the following versions of Splunk: 4.2.2 , 4.2.3 , 4.2.4 , 4.2.5 , 4.3 , 4.3.1 , 4.3.2 , 4.3.3 , 4.3.4 , 4.3.5 , 4.3.6 , 4.3.7 View the Article History for its revisions.


You must be logged into splunk.com in order to post comments. Log in now.

Was this documentation topic helpful?

If you'd like to hear back from us, please provide your email address:

We'd love to hear what you think about this topic or the documentation as a whole. Feedback you enter here will be delivered to the documentation team.

Feedback submitted, thanks!