Developing with Splunk's REST API 9.0
Upcoming Classes
Online
Instructor-led online training
Location | Mar 2023 | Apr 2023 | May 2023 | Jun 2023 | Jul 2023 | Aug 2023 | Sep 2023 |
---|---|---|---|---|---|---|---|
APAC Singapore - Virtual |
Jun 7 – Jun 8 |
Sep 13 – Sep 14 |
|||||
EMEA UK Time - Virtual |
Jun 19 – Jun 20 |
Jul 31 – Aug 1 |
Sep 4 – Sep 5 |

Summary
This nine hour course is for developers who want to use the Splunk REST API to interact with Splunk servers. In this course, you will 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.
Description
- Introduction to the Splunk REST API
- Namespaces and Object Management
- Parsing Output
- Oneshot Searches
- Normal and Export Searches
- Advanced Searching and Job Management
- Working with KV Stores
- Using the HTTP Event Collector (HEC)
Objectives
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
Module 3 – Parsing Output
- Understand the general structure of Atom-based output
- Format Atom-based JSON output
- Write code that uses the API and parse responses
Module 4 – Oneshot Searches
- Review search language syntax and search best practices
- Execute a oneshot search
- Get search results
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 a real time search
- Work with saved searches
- Manage search jobs
Module 7 – Working with the KV Store
- 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
Module 9 – Useful Admin REST APIs
- Get system information
- Manage Splunk configuration files
- Manage Indexes
Module 10 – Custom REST Endpoints
- Extending the Splunk REST API
- Publish your own endpoints
- Using custom REST API endpoints
Prerequisites
To be successful, students should have a solid understanding of the following courses:
- Splunk Fundamentals 1
- Splunk Fundamentals 2
- What Is Splunk?
- Intro to Splunk
- Using Fields
- Working with Time
- Statistical Processing
- Search Under the Hood
- Introduction to Knowledge Objects
- Splunk Enterprise Data Administration (recommended)