A controllable logging module.

Base class for HTTP abstraction.

This class provides the basic functionality (get/post/delete/request), as well as utilities to construct uniform responses.

Base classes should only override makeRequest and parseJSON

Various utility functions for the Splunk SDK

Utilities for Async control flow and collection handling

Abstraction over the Splunk HTTP-wire protocol

This class provides the basic functionality for communicating with a Splunk instance over HTTP. It will handle authentication and authorization, and formatting HTTP requests (GET/POST/DELETE) in the format Splunk expects.

Root access point to the Splunk REST API

This Service class provides "typed" access to Splunk concepts such as searches, indexes, apps and more, as well as providing convenience methods to authenticate and get more specialized instances of the service.

Base definition for a Splunk endpoint (specific service + path combination).

This Endpoint class provides convenience methods for the three HTTP verbs used in splunkjs. It will automatically prepare the path correctly, and allows for relative calls.

Base definition for a Splunk "resource" (e.g. index, jobs, etc)

This Resource class provides basic methods for handling Splunk resources, such as validation, property accessor, etc. This class should not be used directly, as most methods are meant to be overridden.

Base class for a Splunk "entity", which is a well defined construct with certain operations (like "properties", "update", "delete").

This Entity class provides basic methods for handling Splunk entities, such as fetching them, updating, etc.

Base class for a Splunk "collection", which is a well defined construct with certain operations (like "list", "create", etc).

This Collection class provides basic methods for handling Splunk entity collection, such as creating an entity, listing entities, etc.

Represents a specific Splunk saved search. You can update, remove and perform various operations on this saved search.

Represents the Splunk collection of saved searches. You can create and list saved searches using this container, or get a specific one.

Represents a specific Splunk application. You can update, remove and perform various operations on this application.

Represents the Splunk collection of applications. You can create and list applications using this container, or get a specific one.

Represents the server info

Represents a specific Splunk user. You can update, remove and perform various operations on this user.

Represents the Splunk collection of users. You can create and list users using this container, or get a specific one.

Represents a specific Splunk view. You can update, remove and perform various operations on this view.

Represents the Splunk collection of views. You can create and list views using this container, or get a specific one.

Represents a specific Splunk index. You can update and submit events to this index.

Represents the Splunk collection of indexes. You can create and list indexes using this container, or get a specific one.

Represents a specific Splunk stanza. You can update and remove this stanza.

Represents the Splunk collection of stanzas for a specific property file. You can create and list stanzas using this container, or get a specific one.

Represents the Splunk collection of configuration files. You can create and list files using this container, or get a specific one.

Represents a specific Splunk search job. You can perform various operations on this job, such as reading its status, cancelling it, getting results and so on.

Represents the Splunk collection of jobs. You can create and list search jobs using this container, or get a specific one.