Skip to main content

A wrapper around the Splunk REST API endpoint

Project description

splunk-toolbox

Version 1.2.0

A better wrapper around the Splunk ITSI Rest API and Splunk Core API for anyone feeling the pain

Intended Runtime & Required Packages

** Python V3.x ** see requirements.txt for requirements

Version table

  • 1.0.0 initial PoC/format
  • 1.1.0 added Post update to ITSI Notable Event Group
  • 1.1.1 bugfix & clarification of requirements for post_update_to_notable_event_group
  • 1.1.2 added handler for status code interpretation to post update to notable event group
  • 1.2.0 added splunk retrieve search jobs and save them as XML to the toolbox

Intended to solve stability issues produced by the product itself.

Splunk Toolbox Bio

This is a wrapper around the ITSI API. Where the ITSI API is not functioning, we are using sftp calls instead or core API.

Example Uses

Retrieve active search jobs from ITSI

splunk_server = splunkInstance(authPass='mypass')
splunk_server.retrieve_search_jobs(recordSearches=1)

Post updates to ITSI Notable Event Group

splunk_server = splunkInstance(authPass='mypass')
payload ={"status":"5"}
splunk_server.post_update_to_notable_event_group(payload=payload, )

Retrieve all Splunk Core Searches on a given server

if record Searches == 1, a file with the name recordedSearches.xml will be generated and saved with todays date and time

splunk_server = splunkInstance(host='someIP', authPass='PASS')
splunk_server.retrieve_configured_saved_searches(recordSearches=1)

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for splunk-toolbox, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size splunk-toolbox-1.2.0.macosx-10.13-x86_64.tar.gz (8.8 kB) File type Source Python version None Upload date Hashes View
Filename, size splunk_toolbox-1.2.0-py3-none-any.whl (6.7 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page