App Framework Reference

Extension point dictionary

Extension point dictionary The extension point dictionary lists the software points and mechanisms for extending core Splunk.

API reference

Splunk API class Splunk.Context Encapsulates the shared Splunk view context.
class Splunk.Job Encapsulates job object instantiation and utilities.
class Splunk.Search Encapsulates the interface to Splunk search objects and basic utility functions.
class Splunk.TimeRange Encapsulates the interface to store and retrieve a time range that constrains a search.
Splunk.util library
 Encapsulates utilities that expose core functionality.
Module API class Splunk.Module Base class from which all modules inherit.
class ... Splunk.Module.DispatchingModule Base class for building modules used to dispatch a context search job.
Module Controller API class ModuleController Base class for creating module controllers.
class ModuleHandler Abstract controller class for generating content in response to a GET request.
Controller API class BaseController Abstract class for creating a Splunk Web controller or module controller.
Model API class SplunkRESTModel Model wrapper around REST resources.
class SplunkAppObjModel Model wrapper around REST resources and metadata.
class ObjectMetadataModel Model wrapper around metadata attached to REST resources.
class SplunkRESTManager Provides the base interface to REST resources.
class SplunkQuerySet Provides a simple query set for splunkd model objects.
Decorators API decorator library Utility macros.
Template Utilities API template library Mako module templates to define default HTML.
App Server Utilities API app server utilities library Special-purpose App Server utilities.