Developing with Splunk's REST API (DSRAPI)


Course Content

In this course, use curl and Python to send requests to Splunk REST endpoints and learn how to parse and use the results. Create a variety of objects in Splunk, learn how to change properties, work with and apply security to Splunk objects, run different types of searches and parse its results, ingest data using the HTTP Event Collector and manipulate collections and KV Stores.

Please note that this class may run over two days, with 4.5 hour sessions each day, with a total of nine hours of content.

Who should attend

This 9-hour course is for developers who want to use the Splunk REST API to interact with Splunk servers.


To be successful, students should have a solid understanding of the following:

  • Splunk Fundamentals 1 and 2 (Retired)

Or the following single-subject courses:

Students should also understand the following courses:

Course Objectives

  • Introduction to the Splunk REST API
  • Namespaces and Object Management
  • Parsing Output
  • Oneshot Searching
  • Normal and Export Searching
  • Advanced Searching and Job Management
  • Working with KV Stores
  • Using the HTTP Event Collector (HEC)

Outline: Developing with Splunk's REST API (DSRAPI)

Module 1 – Introduction to the Splunk REST API

  • Introduce the Splunk development environment and its REST endpoints
  • Connect to the appropriate Splunk server to accomplish a desired task
  • Authenticate with a Splunk server, with and without a session

Module 2 – Namespaces and Object Management

  • Understand general CRUD with the REST API
  • Identify how a namespace affects access to objects
  • Use the servicesNS node and a namespace to access objects
  • Understand how the sharing level and access control lists affect access to objects
  • Modify the sharing level and the permissions on an object
  • Use the rest command.

Module 3 – Parsing Output

  • Understand the general structure of Atom-based output
  • Format Atom-based XML and JSON output
  • Write code that uses the API and parse responses

Module 4 – Oneshot Searches

  • Review search language syntax and search best practices
  • Execute one shot searches
  • Get search results and parse them

Module 5–Normal and Export Searches

  • Identify types of searches
  • Execute normal and export searches
  • Get search results, job status and search job properties.

Module 6 – Advanced Searching and Job Management

  • Execute real-time searches
  • Work with large result sets
  • Work with saved searches
  • Manage search jobs

Module 7 – Working with KV Stores

  • Define the function of a KV Store
  • Define collections and records
  • Perform CRUD operations on collections and records

Module 8 – Using the HTTP Event Collector (HEC)

  • Create and use HEC tokens
  • Input data using HEC endpoints
  • Get indexer event acknowledgements

Appendix – Useful Admin REST APIs

  • Get system information
  • Manage Splunk configuration files
  • Manage Indexes

Prices & Delivery methods

Online Training

2 days

  • Online Training: CAD 1,270
  • Online Training: US$ 1,000
  • Splunk Training Credits: 100 SPC
Classroom Training

2 days

  • Canada: CAD 1,270
  • Splunk Training Credits: 100 SPC

Click on town name or "Online Training" to book Schedule

This is an Instructor-Led Classroom course
Instructor-led Online Training:   This computer icon in the schedule indicates that this date/time will be conducted as Instructor-Led Online Training.
*   This class is delivered by a partner.

United States

Online Training 09:00 US/Eastern * Enroll
Online Training 09:00 US/Pacific * Enroll
Online Training 09:00 US/Eastern * Enroll