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


Download files

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

Source Distribution

Built Distribution

splunk_toolbox-1.2.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file splunk-toolbox-1.2.0.macosx-10.13-x86_64.tar.gz.

File metadata

  • Download URL: splunk-toolbox-1.2.0.macosx-10.13-x86_64.tar.gz
  • Upload date:
  • Size: 8.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.19.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/2.7.15

File hashes

Hashes for splunk-toolbox-1.2.0.macosx-10.13-x86_64.tar.gz
Algorithm Hash digest
SHA256 4062f33f6e07f80f9ffa41d721bf8cfca5691726172bc7f5445da48780cd53cb
MD5 52e0fb7ee18a52e8679cd0c93762a2ff
BLAKE2b-256 c0a9f877e1a25170636054f66ed4e0a4ede9e7f65c75e38223a26ce59df97a08

See more details on using hashes here.

File details

Details for the file splunk_toolbox-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: splunk_toolbox-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/40.5.0 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.1

File hashes

Hashes for splunk_toolbox-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43c5a2f585060405b60210f7846ccd37d2db21022898ba17f11dab93f1818fec
MD5 4802c42adce63e3185c41f7bed821faf
BLAKE2b-256 5097e56ed6bc4321905917a8465e6bfeea111a7cb75ba1ed2bf3598e7943d3e9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page