index.rst

Welcome to the API reference for the Splunk SDK for Python, which describes the modules that are included in the SDK. For more information, see the Splunk Developer Portal.

binding

~splunklib.binding.connect function

~splunklib.binding.namespace function

~splunklib.binding.Context class

~splunklib.binding.ResponseReader class

Exceptions

~splunklib.binding.handler function

~splunklib.binding.AuthenticationError class

Custom HTTP handler

~splunklib.binding.HTTPError class

~splunklib.binding.HttpLib class

client

~splunklib.client.connect function

~splunklib.client.Service class

~splunklib.client.Endpoint base class

Entities and collections

~splunklib.client.Entity class

~splunklib.client.Collection class

~splunklib.client.ReadOnlyCollection class

~splunklib.client.Application class

~splunklib.client.AlertGroup class

~splunklib.client.ConfigurationFile class

~splunklib.client.Stanza class

~splunklib.client.Configurations class

~splunklib.client.Index class

~splunklib.client.Indexes class

~splunklib.client.Input class

~splunklib.client.Inputs class

~splunklib.client.Job class

~splunklib.client.Jobs class

~splunklib.client.KVStoreCollection class

~splunklib.client.KVStoreCollectionData class

~splunklib.client.KVStoreCollections class

~splunklib.client.Loggers class

~splunklib.client.Message class

~splunklib.client.ModularInputKind class

~splunklib.client.Role class

~splunklib.client.Roles class

~splunklib.client.SavedSearch class

~splunklib.client.SavedSearches class

~splunklib.client.Settings class

~splunklib.client.StoragePassword class

~splunklib.client.StoragePasswords class

~splunklib.client.User class

~splunklib.client.Users class

Exceptions

~splunklib.client.AmbiguousReferenceException class

~splunklib.client.IllegalOperationException class

~splunklib.client.IncomparableException class

~splunklib.client.InvalidNameException class

~splunklib.client.NoSuchCapability class

~splunklib.client.NotSupportedError class

~splunklib.client.OperationError class

data

~splunklib.data.load function

~splunklib.data.record function

~splunklib.data.Record class

results

~splunklib.results.ResultsReader class

~splunklib.results.Message class

modularinput

~splunklib.modularinput.Argument class

~splunklib.modularinput.Event class

~splunklib.modularinput.EventWriter class

~splunklib.modularinput.InputDefinition class

~splunklib.modularinput.Scheme class

~splunklib.modularinput.Script class

~splunklib.modularinput.ValidationDefinition class

searchcommands

~splunklib.searchcommands.EventingCommand class

~splunklib.searchcommands.GeneratingCommand class

~splunklib.searchcommands.ReportingCommand class

~splunklib.searchcommands.StreamingCommand class

~splunklib.searchcommands.Option class