Click or drag to resize
Splunk.Client Namespace
This package contains the Splunk Portable Client for consuming Splunk's API.
Classes
  ClassDescription
Public classApplication
Provides a class for managing Splunk applications.
Public classApplicationArchiveInfo
Provides information about an application archive produced by Splunk.
Public classApplicationAttributes
Provides arguments for setting the attributes of an Application.
Public classApplicationCollection
Provides an object representation of a collection of Splunk applications.
Public classApplicationCollectionFilter
Provides selection criteria for retrieving a slice of an ApplicationCollection.
Public classApplicationSetupInfo
Represents the setup information for an Application.
Public classApplicationUpdateInfo
Provides an object representation for the update information available for an application.
Public classApplicationUpdateInfoUpdateAdapter
An update adapter.
Public classArgsTArgs
Provides a base class for representing strongly typed arguments to Splunk endpoints.
Public classArgument
Represents the value of a parameter to a Splunk REST API endpoint.
Public classArgumentSet
Provides custom arguments.
Public classAtomEntry
Provides an object representation of an individual entry in a Splunk Atom Feed response.

References:

  1. REST API Reference Manual: Accessing Splunk resources.
  2. REST API Reference Manual: Atom Feed responses.

Public classAtomFeed
Provides an object representation of a Splunk Atom Feed response.
Public classAuthenticationFailureException
The exception that is thrown when invalid credentials are passed to LogOnAsync(String, String) or a request fails because the session timed out.
Public classBadRequestException
The exception that is thrown when a request is rejected by Splunk because it is poorly formed.
Public classBaseEntityTResource
Provides an object representation of a Splunk entity.
Public classBaseResource
Provides a base class that represents a Splunk resource as an object.
Public classConfiguration
Provides a class for accessing and updating Splunk configuration files.
Public classConfigurationCollection
Provides an object representation of a collection of Splunk configuration files.
Public classConfigurationSetting
Provides an object representation of a Splunk configuration setting.
Public classConfigurationStanza
Provides an object representation of a Splunk configuration stanza.
Public classContext
Provides a class for sending HTTP requests and receiving HTTP responses from a Splunk server.
Public classCookieStore
Provides a class for storing and parsing cookies from a Splunk server.
Public classCustomJobArgs
Provides custom arguments to a Job.
Public classEai
Provides a class that represents a Splunk server's Extensible Administration Interface.
Public classEaiAcl
Provides a class that represents a Splunk ACL.
Public classEaiAttributes
Provides a class that represents a Splunk ACL.
Public classEndpoint
Provides a base class that represents a Splunk endpoint as an object.
Public classEntityTResource
Provides an object representation of a Splunk entity.
Public classEntityCollectionTEntity, TResource
Provides a base class for representing a collection of Splunk resources.
Public classExpandoAdapter
Public classExpandoAdapterConverter
Public classExpandoAdapterTExpandoAdapter
Public classExpandoAdapterTExpandoAdapterConverter
Public classIndex
Provides a class that represents a Splunk data index.
Public classIndexAttributes
Provides arguments for setting the attributes of an Index.
Public classIndexCollection
Provides an object representation of a collection of Splunk data indexes.
Public classIndexCollectionFilter
Provides arguments for retrieving an IndexCollection.
Public classInternalServerErrorException
The exception that is thrown when a request to retrieve a BaseResource results in HttpStatusCode.InternalServerError.
Public classJob
Provides an object representation of a Splunk search job.
Public classJobRuntimeAdapter
Public classJobArgs
Provides arguments for creating a search Job.
Public classJobCollection
Provides an object representation of a collection of Splunk search jobs.
Public classJobCollectionFilter
Provides arguments for retrieving a JobCollection.
Public classMessage
Provides a class that represents a Splunk service response message.
Public classNamespace
Specifies the user/app context for a resource.
Public classObservableT
Defines a provider for push-based notification.
Public classObserverT
Provides a class for faking git requests and responses from a Splunk server.
Public classPermissions
Provides access to read/write permissions.
Public classRequestException
The expception that is thrown when a Splunk service request fails.
Public classResource
Provides a base class that represents a Splunk resource as an object.
Public classResourceCollection
Provides a base class that represents a Splunk resource as an object.
Public classResourceName
Represents a Splunk resource name.
Public classResourceNotFoundException
The exception that is thrown when a request to retrieve a resource results in NotFound.
Public classResponse
Represents a Splunk service response.
Public classSavedSearch
Provides an object representation of a Splunk saved search.
Public classSavedSearchActionsAdapter
The actions adapter.
Public classSavedSearchActionsAdapterActionTAction
An action.
Public classSavedSearchActionsAdapterEmailAdapter
An e-mail adapter.
Public classSavedSearchActionsAdapterPopulateLookupAdapter
A populate lookup adapter.
Public classSavedSearchActionsAdapterRssAdapter
The RSS adapter.
Public classSavedSearchActionsAdapterScriptAdapter
A script adapter.
Public classSavedSearchActionsAdapterSummaryIndexAdapter
A summary index adapter.
Public classSavedSearchAlertAdapter
An alert adapter.
Public classSavedSearchAlertAdapterSuppressAdapter
The suppress adapter.
Public classSavedSearchAutoSummarizeAdapter
An automatic summarize adapter.
Public classSavedSearchAutoSummarizeAdapterDispatchAdapter
A dispatch adapter.
Public classSavedSearchDispatchAdapter
A dispatch adapter.
Public classSavedSearchDisplayAdapter
A display adapter.
Public classSavedSearchDisplayAdapterEventsAdapter
The events adapter.
Public classSavedSearchDisplayAdapterEventsAdapterListAdapter
A list adapter.
Public classSavedSearchDisplayAdapterEventsAdapterRawAdapter
A raw adapter.
Public classSavedSearchDisplayAdapterEventsAdapterTableAdapter
A table adapter.
Public classSavedSearchDisplayAdapterGeneralAdapter
A general adapter.
Public classSavedSearchDisplayAdapterGeneralAdapterTimeRangePickerAdapter
A time range picker adapter.
Public classSavedSearchDisplayAdapterPageAdapter
A page adapter.
Public classSavedSearchDisplayAdapterPageAdapterPivotAdapter
A pivot adapter.
Public classSavedSearchDisplayAdapterPageAdapterSearchAdapter
A search adapter.
Public classSavedSearchDisplayAdapterPageAdapterSearchAdapterTimelineAdapter
A timeline adapter.
Public classSavedSearchDisplayAdapterStatisticsAdapter
The statistics adapter.
Public classSavedSearchDisplayAdapterVisualizationsAdapter
The visualizations adapter.
Public classSavedSearchDisplayAdapterVisualizationsAdapterChartingAdapter
A charting adapter.
Public classSavedSearchFilter
Provides the arguments required for retrieving information about a SavedSearch
Public classSavedSearchRequestAdapter
A request adapter.
Public classSavedSearchAttributes
Provides the arguments for creating a SavedSearch.
Public classSavedSearchCollection
Represents a collection of saved searches.
Public classSavedSearchCollectionFilter
Provides the arguments required for retrieving SavedSearch entries.
Public classSavedSearchDispatchArgs
Provides the arguments required for retrieving transformed search results.
Public classSavedSearchTemplateArgs
Provides custom arguments to a SavedSearch.
Public classSearchEventArgs
Provides the arguments required for retrieving untransformed search results.
Public classSearchExportArgs
Provides the arguments required for starting a new search export job.
Public classSearchExportStream
The SearchExportStream class represents a streaming XML reader for Splunk SearchResultStream.
Public classSearchPreview
Represents a search result preview on a SearchPreviewStream.
Public classSearchPreviewStream
The SearchPreviewStream class represents a streaming XML reader for Splunk SearchResultStream.
Public classSearchResult
Represents a single record on a SearchResultStream.
Public classSearchResultArgs
Provides arguments for retrieving transformed SearchResultStream.
Public classSearchResultStream
Represents an enumerable, observable stream of SearchResult records.
Public classServer
Provides an object representation of a Splunk server.
Public classServerInfo
Provides information about a Splunk server instance.
Public classServerMessage
Provides an object representation of a Splunk server message entity.
Public classServerMessageCollection
Collection of server messages.
Public classServerMessageCollectionFilter
Provides arguments for retrieving a ServerMessageCollection.
Public classServerSettings
Provides an object representation of the settings of a Splunk server.
Public classServerSettingValues
Provides arguments for updating Splunk Server setting values.
Public classService
Provides access to the Splunk REST API offered on a Splunk management port.
Public classStoragePassword
Provides an object representation of a Splunk storage password.
Public classStoragePasswordCollection
Provides an object representation of a collection of Splunk storage passwords.
Public classStoragePasswordCollectionFilter
Provides arguments for retrieving a StoragePasswordCollection.
Public classTaggedFieldValue
Provides an object representation of a tagged field value.
Public classTransmitter
Provides a class for sending events to Splunk.
Public classTransmitterArgs
Provides arguments for sending events to a Splunk Transmitter.
Public classUnauthorizedAccessException
The exception that is thrown when a request to access a resource results in Forbidden.
Public classValueConverterTValue
Provides a way to convert objects to values of some type.
Structures
  StructureDescription
Public structurePagination
A pagination.
Interfaces
  InterfaceDescription
Public interfaceIApplication
Provides an operational interface to Splunk application entities.
Public interfaceIApplicationArchiveInfo
Interface for application archive information.
Public interfaceIApplicationCollectionTApplication
Provides an operational interface to the Splunk application collection.
Public interfaceIApplicationSetupInfo
Interface for application setup information.
Public interfaceIApplicationUpdateInfo
Interface for application update information.
Public interfaceIBaseResource
Interface for base resource.
Public interfaceIConfigurationTConfigurationStanza
Provides an operational interface for accessing and updating Splunk configuration files.
Public interfaceIConfigurationCollectionTConfiguration, TConfigurationStanza
Provides an operational interface over a collection of Splunk configuration files.
Public interfaceIConfigurationSetting
Interface for configuration setting.
Public interfaceIConfigurationStanza
Interface for configuration stanza.
Public interfaceIEntity
Provides an operational interface common to all Splunk entities.
Public interfaceIEntityCollectionTEntity, TResource
Provides an operational interface common to all Splunk entity collections.
Public interfaceIIndex
Provides an operational interface to Splunk index entities.
Public interfaceIIndexCollectionTIndex
Provides an operational interface to the Splunk application collection.
Public interfaceIJob
Provides an operational interface to a search job.
Public interfaceIJobCollectionTJob
Interface for job collection.
Public interfaceIPaginated
Provides an operational interface to the Splunk application collection.
Public interfaceISavedSearch
Provids an operational interface to Splunk saved search entities.
Public interfaceISavedSearchCollectionTSavedSearch
Provides an operational interface to a Splunk saved search entity collection.
Public interfaceIServer
Interface for server.
Public interfaceIServerInfo
Provides an operational interface to the Splunk server info resource.
Public interfaceIServerMessage
Provides an object representation of a Splunk server message entity.
Public interfaceIServerMessageCollectionTServerMessage
Provides a class for accessing Splunk server messages.
Public interfaceIServerSettings
Provides an operational interface the Splunk server settings resource.
Public interfaceIService
Provides an operational interface to the Splunk REST API.
Public interfaceIStoragePassword
Interface for storage password.
Public interfaceIStoragePasswordCollectionTStoragePassword
Interface for storage password collection.
Public interfaceITransmitter
Interface for transmitter.
Enumerations
  EnumerationDescription
Public enumerationAlertComparator
Used with a threshold value to trigger the alert actions of a SavedSearch.
Public enumerationAlertSeverity
Specifies the severity of an alert triggered by a scheduled search.
Public enumerationAlertTrack
Specifies whether to track the actions triggered by a scheduled search.
Public enumerationAlertType
Specifies the condition under which the alert actions of a SavedSearch are triggered.
Public enumerationDispatchState
Specifies the state of a search Job.
Public enumerationEmailFormat
Specifies the format of text in an e-mail.
Public enumerationExecutionMode
Specifies the type of a Splunk search Job.
Public enumerationLicenseState
Specifies the state of the license installed on a Splunk server instance.
Public enumerationMessageType
Specifies the type of a server response Message.
Public enumerationOutputMode
Specifies the format for the output from a search command.
Public enumerationPaperOrientation
Specifies the page orientation for a report.
Public enumerationPaperSize
Specifies the paper size of a PDF report.
Public enumerationScheme
Values that represent Scheme.
Public enumerationSearchMode
Specifies the mode for a search job.
Public enumerationServerMessageSeverity
Specifies the severity of a ServerMessage.
Public enumerationServerMode
Specifies whether or not a Splunk server instance is a dedicated forwarder.
Public enumerationSharingMode
Values that represent SharingMode.
Public enumerationSortDirection
Specifies the direction in which to sort a list of items.
Public enumerationSortMode
Specifies the direction in which to sort a list of items.
Public enumerationTruncationMode
Provides enumerated values that specify how Splunk reduces the number of lines in the _raw field of events.