Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kolomiichenko/graylog-api

Node.js module for Graylog2 API
https://github.com/kolomiichenko/graylog-api

Last synced: about 2 months ago
JSON representation

Node.js module for Graylog2 API

Awesome Lists containing this project

README 

        
# graylog-api



Node.js module for Graylog2 API.



All methods of this module compatitible with Graylog API v1.1.4 (59783f6).

Search syntax look here: [The search query language](http://docs.graylog.org/en/latest/pages/queries.html).

For more detail you can look Graylog REST API browser: [localhost:12900/api-browser](http://localhost:12900/api-browser).



## Quick examples



```javascript

var graylog = require('graylog-api');

var api = graylog.connect({

  basicAuth: {

    username: 'admin',

    password: 'secret'

  }, // Optional. Default: null. Basic access authentication

  protocol: 'https', // Optional. Default: 'http'. Connection protocol

  host: 'example.com', // Optional. Default: 'localhost'. API hostname

  port: '12900', // Optional. Default: '12900'. API port

  path: '/api' // Optional. Default: ''. API Path

});



api.searchAbsolute({ // parameters

  query: 'source:apache',

  from: '2015-07-24T00:00:00.000Z',

  to: '2015-07-25T00:00:00.000Z',

  limit: '10',

  fields: 'message,timestamp',

  sort: 'asc'

}, function(err, data) { // callback

  if (err) {

    console.log(err);

  } else {

    console.log(data);

  }

});



updateUserPassword({ // parameters

  old_password: 'secret',

  password: 'qwerty123'

}, { // path

  username: 'admin'

}, function (err, data) { // callback

  if (err) {

    console.log(err);

  } else {

    console.log(data);

  }

});



api.getSystem(function(err, data) {  // only callback

  if (!err) {

    console.log(data);

  }

});

```



## Download



The source is available for download from

[GitHub](https://github.com/kolomiichenko/graylog-api).

Alternatively, you can install using Node Package Manager (`npm`):



```bash

  npm install graylog-api

```



## Documentation



API object expression has the same this syntax:



```javascript

api.[methodName]([parameters][, path][, callback]);

```



* `methodName` - The method name

* `parameters` - Object of method to be passed to the API server

* `path` - Optional object of method to be replace path variables

* `callback` - Optional function to be call it after receive api data. First argument is object of error (`null` if no errors), second - data



## Methods



### AlarmCallbacks: Manage stream alarm callbacks

* [`getAlarmCallbacks`](#getAlarmCallbacks)

* [`createAlarmCallback`](#createAlarmCallback)

* [`getAlarmCallbacksAvailable`](#getAlarmCallbacksAvailable)

* [`getAlarmCallback`](#getAlarmCallback)

* [`updateAlarmCallback`](#updateAlarmCallback)

* [`removeAlarmCallback`](#removeAlarmCallback)



### AlertConditions: Manage stream alert conditions

* [`createAlertCondition`](#createAlertCondition)

* [`getAlertConditions`](#getAlertConditions)

* [`updateAlertCondition`](#updateAlertCondition)

* [`removeAlertCondition`](#removeAlertCondition)



### AlertReceivers: Manage stream alert receivers

* [`getAlerts`](#getAlerts)

* [`getAlertsCheck`](#getAlertsCheck)

* [`createAlertReceiver`](#createAlertReceiver)

* [`removeAlertReceiver`](#removeAlertReceiver)

* [`testAlertSendDummy`](#testAlertSendDummy)



### Alerts: Manage stream alerts

* [`getAlerts`](#getAlerts)

* [`getAlertsCheck`](#getAlertsCheck)

* [`createAlertReceiver`](#createAlertReceiver)

* [`removeAlertReceiver`](#removeAlertReceiver)

* [`testAlertSendDummy`](#testAlertSendDummy)



### Counts: Message counts

* [`getCountTotal`](#getCountTotal)



### Dashboards: Manage dashboards

* [`createDashboard`](#createDashboard)

* [`getDashboards`](#getDashboards)

* [`getDashboard`](#getDashboard)

* [`updateDashboard`](#updateDashboard)

* [`removeDashboard`](#removeDashboard)

* [`updateDashboardPositions`](#updateDashboardPositions)

* [`createDashboardWidget`](#createDashboardWidget)

* [`updateDashboardWidget`](#updateDashboardWidget)

* [`removeDashboardWidget`](#removeDashboardWidget)

* [`updateDashboardWidgetCacheTime`](#updateDashboardWidgetCacheTime)

* [`updateDashboardWidgetDescription`](#updateDashboardWidgetDescription)

* [`getDashboardWidgetValue`](#getDashboardWidgetValue)



### Extractors: Extractors of an input

* [`createInputExtractor`](#createInputExtractor)

* [`getInputExtractors`](#getInputExtractors)

* [`updateInputExtractorOrder`](#updateInputExtractorOrder)

* [`updateInputExtractor`](#updateInputExtractor)

* [`removeInputExtractor`](#removeInputExtractor)

* [`getInputExtractor`](#getInputExtractor)



### Filters: Message blacklist filters

* [`createBlacklistFilter`](#createBlacklistFilter)

* [`getBlacklistFilters`](#getBlacklistFilters)

* [`getBlacklistFilter`](#getBlacklistFilter)

* [`updateBlacklistFilter`](#updateBlacklistFilter)

* [`removeBlacklistFilter`](#removeBlacklistFilter)



### Indexer/Cluster: Indexer cluster information

* [`getClusterHealth`](#getClusterHealth)

* [`getClusterName`](#getClusterName)



### Indexer/Failures: Indexer failures

* [`getSystemFailures`](#getSystemFailures)

* [`getFailuresCount`](#getFailuresCount)



### Indexer/Indices: Index information

* [`getIndicesClosed`](#getIndicesClosed)

* [`getIndicesReopened`](#getIndicesReopened)

* [`removeIndex`](#removeIndex)

* [`getIndices`](#getIndices)

* [`closeIndex`](#closeIndex)

* [`reopenIndex`](#reopenIndex)



### Messages: Single messages

* [`analyzeMessage`](#analyzeMessage)

* [`getMessage`](#getMessage)



### Search/Absolute: Message search

* [`searchAbsolute`](#searchAbsolute)

* [`searchAbsoluteFieldHistogram`](#searchAbsoluteFieldHistogram)

* [`searchAbsoluteHistogram`](#searchAbsoluteHistogram)

* [`searchAbsoluteStats`](#searchAbsoluteStats)

* [`searchAbsoluteTerms`](#searchAbsoluteTerms)

* [`searchAbsoluteTermsStats`](#searchAbsoluteTermsStats)



### Search/Keyword: Message search

* [`searchKeyword`](#searchKeyword)

* [`searchKeywordFieldHistogram`](#searchKeywordFieldHistogram)

* [`searchKeywordHistogram`](#searchKeywordHistogram)

* [`searchKeywordStats`](#searchKeywordStats)

* [`searchKeywordTerms`](#searchKeywordTerms)

* [`searchKeywordTermsStats`](#searchKeywordTermsStats)



### Search/Relative: Message search

* [`searchRelative`](#searchRelative)

* [`searchRelativeFieldHistogram`](#searchRelativeFieldHistogram)

* [`searchRelativeHistogram`](#searchRelativeHistogram)

* [`searchRelativeStats`](#searchRelativeStats)

* [`searchRelativeTerms`](#searchRelativeTerms)

* [`searchRelativeTermsStats`](#searchRelativeTermsStats)



### Search/Saved: Saved searches

* [`createSearchSaved`](#createSearchSaved)

* [`getSearchSavedAll`](#getSearchSavedAll)

* [`getSearchSaved`](#getSearchSaved)

* [`updateSearchSaved`](#updateSearchSaved)

* [`removeSearchSaved`](#removeSearchSaved)



### Sources: Listing message sources (e.g. hosts sending logs)

* [`getSources`](#getSources)



### StaticFields: Static fields of an input

* [`createInputStaticField`](#createInputStaticField)

* [`removeInputStaticField`](#removeInputStaticField)



### StreamOutputs: Manage stream outputs for a given stream

* [`createStreamOutput`](#createStreamOutput)

* [`getStreamOutputs`](#getStreamOutputs)

* [`getStreamOutput`](#getStreamOutput)

* [`removeStreamOutput`](#removeStreamOutput)



### StreamRules: Manage stream rules

* [`getStreamRules`](#getStreamRules)

* [`getStreamRule`](#getStreamRule)

* [`createStreamRule`](#createStreamRule)

* [`updateStreamRule`](#updateStreamRule)

* [`removeStreamRule`](#removeStreamRule)



### Streams: Manage streams

* [`getStreams`](#getStreams)

* [`createStream`](#createStream)

* [`getStreamsEnabled`](#getStreamsEnabled)

* [`getStreamThroughput`](#getStreamThroughput)

* [`getStreamAllThroughput`](#getStreamAllThroughput)

* [`getStream`](#getStream)

* [`updateStream`](#updateStream)

* [`removeStream`](#removeStream)

* [`cloneStream`](#cloneStream)

* [`pauseStream`](#pauseStream)

* [`resumeStream`](#resumeStream)

* [`testMatchStream`](#testMatchStream)



### System: System information of this node

* [`getSystem`](#getSystem)

* [`getJVM`](#getJVM)

* [`getThreadDump`](#getThreadDump)



### System/Buffers: Buffer information of this node.

* [`getBuffers`](#getBuffers)

* [`getBuffersClasses`](#getBuffersClasses)



### System/Bundles: Content packs

* [`createBundle`](#createBundle)

* [`getBundles`](#getBundles)

* [`exportBundles`](#exportBundles)

* [`getBundle`](#getBundle)

* [`updateBundle`](#updateBundle)

* [`removeBundle`](#removeBundle)

* [`applyBundle`](#applyBundle)



### System/Cluster: Node discovery

* [`getNodeThis`](#getNodeThis)

* [`getNodes`](#getNodes)

* [`getNode`](#getNode)



### System/ClusterStats: Cluster stats

* [`getClusterStats`](#getClusterStats)

* [`getClusterStatsElasticsearch`](#getClusterStatsElasticsearch)

* [`getClusterStatsMongo`](#getClusterStatsMongo)



### System/Collectors: Management of Graylog Collectors

* [`getSystemCollectors`](#getSystemCollectors)

* [`getSystemCollector`](#getSystemCollector)



### System/Collectors/Registration: Registration resource for Graylog Collector nodes

* [`changeCollector`](#changeCollector)



### System/Debug/Events: For debugging local and cluster events.

* [`createDebugEventsCluster`](#createDebugEventsCluster)

* [`getDebugEventsCluster`](#getDebugEventsCluster)

* [`createDebugEventsLocal`](#createDebugEventsLocal)

* [`getDebugEventsLocal`](#getDebugEventsLocal)



### System/Deflector: Index deflector management

* [`getDeflector`](#getDeflector)

* [`getDeflectorConfig`](#getDeflectorConfig)

* [`nextDeflectorCycle`](#nextDeflectorCycle)



### System/Fields: Get list of message fields that exist.

* [`getFields`](#getFields)



### System/Grok: Manage grok patterns

* [`getGroks`](#getGroks)

* [`getGrok`](#getGrok)

* [`createGrok`](#createGrok)

* [`createGroks`](#createGroks)

* [`updateGrok`](#updateGrok)

* [`removeGrok`](#removeGrok)



### System/IndexRanges: Index timeranges

* [`getIndicesRanges`](#getIndicesRanges)

* [`rebuildIndicesRanges`](#rebuildIndicesRanges)



### System/Inputs: Message inputs of this node

* [`createInput`](#createInput)

* [`getInput`](#getInput)

* [`getInputs`](#getInputs)

* [`updateInput`](#updateInput)

* [`removeInput`](#removeInput)

* [`launchInput`](#launchInput)

* [`restartInput`](#restartInput)

* [`stopInput`](#stopInput)



### System/Inputs/Types: Message input types of this node

* [`getInputsType`](#getInputsType)

* [`getInputsTypes`](#getInputsTypes)



### System/Jobs: System Jobs

* [`createJob`](#createJob)

* [`getJobs`](#getJobs)

* [`getJob`](#getJob)



### System/Journal: Message journal information of this node.

* [`getJournal`](#getJournal)



### System/LDAP: LDAP settings

* [`getLDAPSettings`](#getLDAPSettings)

* [`updateLDAPSettings`](#updateLDAPSettings)

* [`removeLDAPSettings`](#removeLDAPSettings)

* [`testLDAPSettings`](#testLDAPSettings)



### System/LoadBalancers: Status propagation for load balancers

* [`getLoadBalancerStatus`](#getLoadBalancerStatus)

* [`updateLoadBalancerStatusOverride`](#updateLoadBalancerStatusOverride)



### System/Loggers: Internal Graylog loggers

* [`getLoggers`](#getLoggers)

* [`getLoggersSubsystems`](#getLoggersSubsystems)

* [`setLoggersSubsystemsLevel`](#setLoggersSubsystemsLevel)

* [`setLoggersLevel`](#setLoggersLevel)



### System/Messages: Internal Graylog messages

* [`getSystemMessages`](#getSystemMessages)



### System/Metrics: Internal Graylog2 metrics

* [`getMetric`](#getMetric)

* [`getMetrics`](#getMetrics)

* [`getMetricsMultiple`](#getMetricsMultiple)

* [`getMetricsNames`](#getMetricsNames)

* [`getMetricsNamespace`](#getMetricsNamespace)



### System/Metrics/History: Get history of metrics

* [`getMetricsHistory`](#getMetricsHistory)



### System/Notifications: Notifications generated by the system

* [`getNotifications`](#getNotifications)

* [`removeNotification`](#removeNotification)



### System/Outputs: Manage outputs

* [`getOutput`](#getOutput)

* [`getOutputs`](#getOutputs)

* [`createOutput`](#createOutput)

* [`getOutputsAvailable`](#getOutputsAvailable)

* [`updateOutput`](#updateOutput)

* [`removeOutput`](#removeOutput)



### System/Permissions: Retrieval of system permissions

* [`getPermissions`](#getPermissions)

* [`getPermissionsReader`](#getPermissionsReader)



### System/Plugin: Plugin information

* [`getSystemPlugins`](#getSystemPlugins)



### System/Processing: System processing status control

* [`pauseSystemProcessing`](#pauseSystemProcessing)

* [`resumeSystemProcessing`](#resumeSystemProcessing)



### System/Radios: Management of graylog2-radio nodes

* [`getRadio`](#getRadio)

* [`getRadios`](#getRadios)

* [`createRadioInput`](#createRadioInput)

* [`getRadioInputs`](#getRadioInputs)

* [`removeRadioInput`](#removeRadioInput)

* [`pingRadio`](#pingRadio)



### System/ServiceManager: ServiceManager Status

* [`getServiceManager`](#getServiceManager)



### System/Sessions: Login for interactive user sessions

* [`createSession`](#createSession)

* [`removeSession`](#removeSession)



### System/Shutdown: Shutdown this node gracefully

* [`shutdownNode`](#shutdownNode)



### System/Stats: Node system stats

* [`getStats`](#getStats)

* [`getStatsFs`](#getStatsFs)

* [`getStatsJvm`](#getStatsJvm)

* [`getStatsNetwork`](#getStatsNetwork)

* [`getStatsOs`](#getStatsOs)

* [`getStatsProcess`](#getStatsProcess)



### System/Throughput: Message throughput of this node

* [`getThroughput`](#getThroughput)



### Users: User accounts

* [`getUser`](#getUser)

* [`getUsers`](#getUsers)

* [`createUser`](#createUser)

* [`updateUser`](#updateUser)

* [`removeUser`](#removeUser)

* [`updateUserPassword`](#updateUserPassword)

* [`updateUserPermissions`](#updateUserPermissions)

* [`removeUserPermissions`](#removeUserPermissions)

* [`updateUserPreferences`](#updateUserPreferences)

* [`getUserTokens`](#getUserTokens)

* [`createUserToken`](#createUserToken)

* [`removeUserToken`](#removeUserToken)



## AlarmCallbacks: Manage stream alarm callbacks





### getAlarmCallbacks(parameters, path[, callback])



Get a list of all alarm callbacks for this stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose alarm callbacks we want

  * _callback_: {Function} Optional. Callback function





### createAlarmCallback(parameters, path[, callback])



Create an alarm callback



__Arguments__:

  * __parameters__: {Object} {CreateAlarmCallbackRequest}

  * __path__: {Object}

    * __streamid__: {String} The stream id this new alarm callback belongs to

  * _callback_: {Function} Optional. Callback function





### getAlarmCallbacksAvailable(parameters, path[, callback])



Get a list of all alarm callback types



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose alarm callbacks we want

  * _callback_: {Function} Optional. Callback function





### getAlarmCallback(parameters, path[, callback])



Get a single specified alarm callback for this stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose alarm callbacks we want

    * __alarmCallbackId__: {String} The alarm callback id we are getting

  * _callback_: {Function} Optional. Callback function





### updateAlarmCallback(parameters, path[, callback])



Update an alarm callback



__Arguments__:

  * __parameters__: {Object} {Map}

  * __path__: {Object}

    * __streamid__: {String} The stream id this alarm callback belongs to

    * __alarmCallbackId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeAlarmCallback(parameters, path[, callback])



Delete an alarm callback



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The stream id this alarm callback belongs to

    * __alarmCallbackId__: {String}

  * _callback_: {Function} Optional. Callback function



## AlertConditions: Manage stream alert conditions





### createAlertCondition(parameters, path[, callback])



Create an alert condition



__Arguments__:

  * __parameters__: {Object} {CreateConditionRequest}

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### getAlertConditions(parameters, path[, callback])



Get all alert conditions of this stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### updateAlertCondition(parameters, path[, callback])



Modify an alert condition



__Arguments__:

  * __parameters__: {Object} {CreateConditionRequest}

  * __path__: {Object}

    * __streamId__: {String} The stream id the alert condition belongs to

    * __conditionId__: {String} The alert condition id

  * _callback_: {Function} Optional. Callback function





### removeAlertCondition(parameters, path[, callback])



Delete an alert condition



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

    * __conditionId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function



## AlertReceivers: Manage stream alert receivers





### getAlerts(parameters, path[, callback])



Get the 300 most recent alarms of this stream



__Arguments__:

  * __parameters__: {Object}

    * _since_: {Integer} Optional. Optional parameter to define a lower date boundary. (UNIX timestamp)

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### getAlertsCheck(parameters, path[, callback])



Check for triggered alert conditions of this streams. Results cached for 30 seconds



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String} The ID of the stream to check

  * _callback_: {Function} Optional. Callback function





### createAlertReceiver(parameters, path[, callback])



Add an alert receiver



__Arguments__:

  * __parameters__: {Object}

    * __entity__: {String} Name/ID of user or email address to add as alert receiver

    * __type__: {String} Type: users or emails

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### removeAlertReceiver(parameters, path[, callback])



Remove an alert receiver



__Arguments__:

  * __parameters__: {Object}

    * __type__: {String} Type: users or emails

    * __entity__: {String} Name/ID of user or email address to remove from alert receivers

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### testAlertSendDummy(parameters, path[, callback])



Send a test mail for a given stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function



## Alerts: Manage stream alerts





### getAlerts(parameters, path[, callback])



Get the 300 most recent alarms of this stream



__Arguments__:

  * __parameters__: {Object}

    * _since_: {Integer} Optional. Optional parameter to define a lower date boundary. (UNIX timestamp)

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### getAlertsCheck(parameters, path[, callback])



Check for triggered alert conditions of this streams. Results cached for 30 seconds



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String} The ID of the stream to check

  * _callback_: {Function} Optional. Callback function





### createAlertReceiver(parameters, path[, callback])



Add an alert receiver



__Arguments__:

  * __parameters__: {Object}

    * __type__: {String} Type: users or emails

    * __entity__: {String} Name/ID of user or email address to add as alert receiver

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### removeAlertReceiver(parameters, path[, callback])



Remove an alert receiver



__Arguments__:

  * __parameters__: {Object}

    * __type__: {String} Type: users or emails

    * __entity__: {String} Name/ID of user or email address to remove from alert receivers

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function





### testAlertSendDummy(parameters, path[, callback])



Send a test mail for a given stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String} The stream id this new alert condition belongs to

  * _callback_: {Function} Optional. Callback function



## Counts: Message counts





### getCountTotal([callback])



Total number of messages in all your indices



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## Dashboards: Manage dashboards





### createDashboard(parameters[, callback])



Create a dashboard



__Arguments__:

  * __parameters__: {Object} {CreateDashboardRequest}

  * _callback_: {Function} Optional. Callback function





### getDashboards([callback])



Get a list of all dashboards and all configurations of their widgets



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getDashboard(parameters, path[, callback])



Get a single dashboards and all configurations of its widgets



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __dashboardId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateDashboard(parameters, path[, callback])



Update the settings of a dashboard



__Arguments__:

  * __parameters__: {Object} {UpdateDashboardRequest}

  * __path__: {Object}

    * __dashboardId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeDashboard(parameters, path[, callback])



Delete a dashboard and all its widgets



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __dashboardId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateDashboardPositions(parameters, path[, callback])



Update/set the positions of dashboard widgets



__Arguments__:

  * __parameters__: {Object} {WidgetPositionsRequest}

  * __path__: {Object}

    * __dashboardId__: {String}

  * _callback_: {Function} Optional. Callback function





### createDashboardWidget(parameters, path[, callback])



Add a widget to a dashboard



__Arguments__:

  * __parameters__: {Object} {AddWidgetRequest}

  * __path__: {Object}

    * __dashboardId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateDashboardWidget(parameters, path[, callback])



Update a widget



__Arguments__:

  * __parameters__: {Object} {AddWidgetRequest}

  * __path__: {Object}

    * __dashboardId__: {String}

    * __widgetId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeDashboardWidget(parameters, path[, callback])



Delete a widget



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __dashboardId__: {String}

    * __widgetId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateDashboardWidgetCacheTime(parameters, path[, callback])



Update cache time of a widget



__Arguments__:

  * __parameters__: {Object} {UpdateWidgetRequest}

  * __path__: {Object}

    * __dashboardId__: {String}

    * __widgetId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateDashboardWidgetDescription(parameters, path[, callback])



Update description of a widget



__Arguments__:

  * __parameters__: {Object} {UpdateWidgetRequest}

  * __path__: {Object}

    * __dashboardId__: {String}

    * __widgetId__: {String}

  * _callback_: {Function} Optional. Callback function





### getDashboardWidgetValue(parameters, path[, callback])



Get a single widget value



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __dashboardId__: {String}

    * __widgetId__: {String}

  * _callback_: {Function} Optional. Callback function



## Extractors: Extractors of an input





### createInputExtractor(parameters, path[, callback])



Add an extractor to an input



__Arguments__:

  * __parameters__: {Object} {CreateExtractorRequest}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### getInputExtractors(parameters, path[, callback])



List all extractors of an input



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateInputExtractorOrder(parameters, path[, callback])



Update extractor order of an input



__Arguments__:

  * __parameters__: {Object} {OrderExtractorsRequest}

  * __path__: {Object}

    * __inputId__: {String} Persist ID (!) of input

  * _callback_: {Function} Optional. Callback function





### updateInputExtractor(parameters, path[, callback])



Update an extractor



__Arguments__:

  * __parameters__: {Object} {CreateExtractorRequest}

  * __path__: {Object}

    * __inputId__: {String}

    * __extractorId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeInputExtractor(parameters, path[, callback])



Delete an extractor



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

    * __extractorId__: {String}

  * _callback_: {Function} Optional. Callback function





### getInputExtractor(parameters, path[, callback])



Get information of a single extractor of an input



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

    * __extractorId__: {String}

  * _callback_: {Function} Optional. Callback function



## Filters: Message blacklist filters





### createBlacklistFilter(parameters[, callback])



Create a blacklist filter



It can take up to a second until the change is applied



__Arguments__:

  * __parameters__: {Object}

    * __filterEntry__: {FilterDescription}

  * _callback_: {Function} Optional. Callback function





### getBlacklistFilters([callback])



Get all blacklist filters



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getBlacklistFilter(parameters, path[, callback])



Get the existing blacklist filter



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __filterId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateBlacklistFilter(parameters, path[, callback])



Update an existing blacklist filter



It can take up to a second until the change is applied



__Arguments__:

  * __parameters__: {Object}

    * __filterEntry__: {FilterDescription}

  * __path__: {Object}

    * __filterId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeBlacklistFilter(parameters, path[, callback])



Remove the existing blacklist filter



It can take up to a second until the change is applied



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __filterId__: {String}

  * _callback_: {Function} Optional. Callback function



## Indexer/Cluster: Indexer cluster information





### getClusterHealth([callback])



Get cluster and shard health overview



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getClusterName([callback])



Get the cluster name



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## Indexer/Failures: Indexer failures





### getSystemFailures(parameters[, callback])



Get a list of failed index operations



__Arguments__:

  * __parameters__: {Object}

    * __limit__: {Integer} Limit

    * __offset__: {Integer} Offset

  * _callback_: {Function} Optional. Callback function





### getFailuresCount(parameters[, callback])



Total count of failed index operations since the given date



__Arguments__:

  * __parameters__: {Object}

    * __since__: {String} ISO8601 date

  * _callback_: {Function} Optional. Callback function



## Indexer/Indices: Index information





### getIndicesClosed([callback])



Get a list of closed indices that can be reopened



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getIndicesReopened([callback])



Get a list of reopened indices, which will not be cleaned by retention cleaning



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### removeIndex(parameters, path[, callback])



Delete an index. This will also trigger an index ranges rebuild job



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * _index_: {String} Optional.

  * _callback_: {Function} Optional. Callback function





### getIndices(parameters, path[, callback])



Get information of an index and its shards



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * _index_: {String} Optional.

  * _callback_: {Function} Optional. Callback function





### closeIndex(parameters, path[, callback])



Close an index. This will also trigger an index ranges rebuild job



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * _index_: {String} Optional.

  * _callback_: {Function} Optional. Callback function





### reopenIndex(parameters, path[, callback])



Reopen a closed index. This will also trigger an index ranges rebuild job



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * _index_: {String} Optional.

  * _callback_: {Function} Optional. Callback function



## Messages: Single messages





### analyzeMessage(parameters, path[, callback])



Analyze a message string



Returns what tokens/terms a message string (message or full_message) is split to



__Arguments__:

  * __parameters__: {Object}

    * __string__: {String} The string to analyze

  * __path__: {Object}

    * __index__: {String} The index the message containing the string is stored in

  * _callback_: {Function} Optional. Callback function





### getMessage(parameters, path[, callback])



Get a single message



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __index__: {String} The index this message is stored in

    * __messageId__: {String}

  * _callback_: {Function} Optional. Callback function



## Search/Absolute: Message search





### searchAbsolute(parameters[, callback])



Message search with absolute timerange



Search for messages using an absolute timerange, specified as from/to with format yyyy-MM-ddTHH:mm:ss.SSSZ (e.g. 2014-01-23T15:34:49.000Z) or yyyy-MM-dd HH:mm:ss



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __from__: {String} Timerange start. See description for date format

    * __to__: {String} Timerange end. See description for date format

    * _limit_: {Integer} Optional. Maximum number of messages to return

    * _offset_: {Integer} Optional. Offset

    * _filter_: {String} Optional. Filter

    * __fields__: {String} Comma separated list of fields to return

  * _callback_: {Function} Optional. Callback function





### searchAbsoluteFieldHistogram(parameters[, callback])



Field value histogram of a query using an absolute timerange



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __field__: {String} Field of whose values to get the histogram of

    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)

    * __from__: {String} Timerange start. See search method description for date format

    * __to__: {String} Timerange end. See search method description for date format

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchAbsoluteHistogram(parameters[, callback])



Datetime histogram of a query using an absolute timerange



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)

    * __from__: {String} Timerange start. See search method description for date format

    * __to__: {String} Timerange end. See search method description for date format

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchAbsoluteStats(parameters[, callback])



Field statistics for a query using an absolute timerange



Returns statistics like min/max or standard deviation of numeric fields over the whole query result set



__Arguments__:

  * __parameters__: {Object}

    * __field__: {String} Message field of numeric type to return statistics for

    * __query__: {String} Query (Lucene syntax)

    * __from__: {String} Timerange start. See search method description for date format

    * __to__: {String} Timerange end. See search method description for date format

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchAbsoluteTerms(parameters[, callback])



Most common field terms of a query using an absolute timerange



__Arguments__:

  * __parameters__: {Object}

    * __field__: {String} Message field of to return terms of

    * __query__: {String} Query (Lucene syntax)

    * _size_: {Integer} Optional. Maximum number of terms to return

    * __from__: {String} Timerange start. See search method description for date format

    * __to__: {String} Timerange end. See search method description for date format

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchAbsoluteTermsStats(parameters[, callback])



Ordered field terms of a query computed on another field using an absolute timerange



__Arguments__:

  * __parameters__: {Object}

    * __key_field__: {String} Message field of to return terms of

    * __value_field__: {String} Value field used for computation

    * __order__: {String} What to order on (Allowed values: TERM, REVERSE_TERM, COUNT, REVERSE_COUNT, TOTAL, REVERSE_TOTAL, MIN, REVERSE_MIN, MAX, REVERSE_MAX, MEAN, REVERSE_MEAN)

    * __query__: {String} Query (Lucene syntax)

    * _size_: {Integer} Optional. Maximum number of terms to return

    * __from__: {String} Timerange start. See search method description for date format

    * __to__: {String} Timerange end. See search method description for date format

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function



## Search/Keyword: Message search





### searchKeyword(parameters[, callback])



Message search with keyword as timerange



Search for messages in a timerange defined by a keyword like "yesterday" or "2 weeks ago to wednesday"



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __keyword__: {String} Range keyword

    * _limit_: {Integer} Optional. Maximum number of messages to return

    * _offset_: {Integer} Optional. Offset

    * _filter_: {String} Optional. Filter

    * _fields_: {String} Optional. Comma separated list of fields to return

    * _sort_: {String} Optional. Sorting (field:asc / field:desc)

  * _callback_: {Function} Optional. Callback function





### searchKeywordFieldHistogram(parameters[, callback])



Datetime histogram of a query using keyword timerange



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __field__: {String} Field of whose values to get the histogram of

    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)

    * __keyword__: {String} Range keyword

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchKeywordHistogram(parameters[, callback])



Datetime histogram of a query using keyword timerange



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)

    * __keyword__: {String} Range keyword

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchKeywordStats(parameters[, callback])



Field statistics for a query using a keyword timerange



Returns statistics like min/max or standard deviation of numeric fields over the whole query result set



__Arguments__:

  * __parameters__: {Object}

    * __field__: {String} Message field of numeric type to return statistics for

    * __query__: {String} Query (Lucene syntax)

    * __keyword__: {String} Range keyword

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchKeywordTerms(parameters[, callback])



Most common field terms of a query using a keyword timerange



__Arguments__:

  * __parameters__: {Object}

    * __field__: {String} Message field of to return terms of

    * __query__: {String} Query (Lucene syntax)

    * _size_: {Integer} Optional. Maximum number of terms to return

    * __keyword__: {String} Range keyword

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchKeywordTermsStats(parameters[, callback])



Ordered field terms of a query computed on another field using a keyword timerange



__Arguments__:

  * __parameters__: {Object}

    * __key_field__: {String} Message field of to return terms of

    * __value_field__: {String} Value field used for computation

    * __order__: {String} What to order on (Allowed values: TERM, REVERSE_TERM, COUNT, REVERSE_COUNT, TOTAL, REVERSE_TOTAL, MIN, REVERSE_MIN, MAX, REVERSE_MAX, MEAN, REVERSE_MEAN)

    * __query__: {String} Query (Lucene syntax)

    * _size_: {Integer} Optional. Maximum number of terms to return

    * __keyword__: {String} Keyword timeframe

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function



## Search/Relative: Message search





### searchRelative(parameters[, callback])



Message search with relative timerange



Search for messages in a relative timerange, specified as seconds from now. Example: 300 means search from 5 minutes ago to now



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __range__: {Integer} Relative timeframe to search in. See method description

    * _limit_: {Integer} Optional. Maximum number of messages to return

    * _offset_: {Integer} Optional. Offset

    * _filter_: {String} Optional. Filter

    * __fields__: {String} Comma separated list of fields to return

  * _callback_: {Function} Optional. Callback function





### searchRelativeFieldHistogram(parameters[, callback])



Field value histogram of a query using a relative timerange



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __field__: {String} Field of whose values to get the histogram of

    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)

    * __range__: {Integer} Relative timeframe to search in. See search method description

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchRelativeHistogram(parameters[, callback])



Datetime histogram of a query using a relative timerange



__Arguments__:

  * __parameters__: {Object}

    * __query__: {String} Query (Lucene syntax)

    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)

    * __range__: {Integer} Relative timeframe to search in. See search method description

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchRelativeStats(parameters[, callback])



Field statistics for a query using a relative timerange



Returns statistics like min/max or standard deviation of numeric fields over the whole query result set



__Arguments__:

  * __parameters__: {Object}

    * __field__: {String} Message field of numeric type to return statistics for

    * __query__: {String} Query (Lucene syntax)

    * __range__: {Integer} Relative timeframe to search in. See search method description

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchRelativeTerms(parameters[, callback])



Most common field terms of a query using a relative timerange



__Arguments__:

  * __parameters__: {Object}

    * __field__: {String} Message field of to return terms of

    * __query__: {String} Query (Lucene syntax)

    * _size_: {Integer} Optional. Maximum number of terms to return

    * __range__: {Integer} Relative timeframe to search in. See search method description

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function





### searchRelativeTermsStats(parameters[, callback])



Ordered field terms of a query computed on another field using a relative timerange



__Arguments__:

  * __parameters__: {Object}

    * __key_field__: {String} Message field of to return terms of

    * __value_field__: {String} Value field used for computation

    * __order__: {String} What to order on (Allowed values: TERM, REVERSE_TERM, COUNT, REVERSE_COUNT, TOTAL, REVERSE_TOTAL, MIN, REVERSE_MIN, MAX, REVERSE_MAX, MEAN, REVERSE_MEAN)

    * __query__: {String} Query (Lucene syntax)

    * _size_: {Integer} Optional. Maximum number of terms to return

    * __range__: {Integer} Relative timeframe to search in. See search method description

    * _filter_: {String} Optional. Filter

  * _callback_: {Function} Optional. Callback function



## Search/Saved: Saved searches





### createSearchSaved(parameters[, callback])



Create a new saved search



__Arguments__:

  * __parameters__: {Object} {CreateSavedSearchRequest}

  * _callback_: {Function} Optional. Callback function





### getSearchSavedAll([callback])



Get a list of all saved searches



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getSearchSaved(parameters, path[, callback])



Get a single saved search



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __searchId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateSearchSaved(parameters, path[, callback])



Update a saved search



__Arguments__:

  * __parameters__: {Object} {CreateSavedSearchRequest}

  * __path__: {Object}

    * __searchId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeSearchSaved(parameters, path[, callback])



Delete a saved search



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __searchId__: {String}

  * _callback_: {Function} Optional. Callback function



## Sources: Listing message sources (e.g. hosts sending logs)





### getSources(parameters[, callback])



Get a list of all sources (not more than 5000) that have messages in the current indices. The result is cached for 10 seconds



Range: The parameter is in seconds relative to the current time. 86400 means "in the last day", 0 is special and means "across all indices"



__Arguments__:

  * __parameters__: {Object}

    * __range__: {Integer} Relative timeframe to search in. See method description

  * _callback_: {Function} Optional. Callback function



## StaticFields: Static fields of an input





### createInputStaticField(parameters, path[, callback])



Add a static field to an input



__Arguments__:

  * __parameters__: {Object} {CreateStaticFieldRequest}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeInputStaticField(parameters, path[, callback])



Remove static field of an input



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __Key__: {String}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function



## StreamOutputs: Manage stream outputs for a given stream





### createStreamOutput(parameters, path[, callback])



Associate outputs with a stream



__Arguments__:

  * __parameters__: {Object} {AddOutputRequest}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose outputs we want

  * _callback_: {Function} Optional. Callback function





### getStreamOutputs(parameters, path[, callback])



Associate outputs with a stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose outputs we want

  * _callback_: {Function} Optional. Callback function





### getStreamOutput(parameters, path[, callback])



Get specific output of a stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose outputs we want

  * _callback_: {Function} Optional. Callback function





### removeStreamOutput(parameters, path[, callback])



Delete output of a stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose outputs we want

    * __outputId__: {String} The id of the output that should be deleted

  * _callback_: {Function} Optional. Callback function



## StreamRules: Manage stream rules





### getStreamRules(parameters, path[, callback])



Get a list of all stream rules



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose stream rule we want

  * _callback_: {Function} Optional. Callback function





### getStreamRule(parameters, path[, callback])



Get a single stream rules



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The id of the stream whose stream rule we want

    * __streamRuleId__: {String} The stream rule id we are getting

  * _callback_: {Function} Optional. Callback function





### createStreamRule(parameters, path[, callback])



Create a stream rule



__Arguments__:

  * __parameters__: {Object} {CreateStreamRuleRequest}

  * __path__: {Object}

    * __streamid__: {String} The stream id this new rule belongs to

  * _callback_: {Function} Optional. Callback function





### updateStreamRule(parameters, path[, callback])



Update a stream rule



__Arguments__:

  * __parameters__: {Object} {CreateStreamRuleRequest}

  * __path__: {Object}

    * __streamid__: {String} The stream id this rule belongs to

    * __streamRuleId__: {String} The stream rule id we are updating

  * _callback_: {Function} Optional. Callback function





### removeStreamRule(parameters, path[, callback])



Delete a stream rule



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamid__: {String} The stream id this new rule belongs to

    * __streamRuleId__: {String}

  * _callback_: {Function} Optional. Callback function



## Streams: Manage streams





### getStreams([callback])



Get a list of all streams



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### createStream(parameters[, callback])



Create a stream



__Arguments__:

  * __parameters__: {Object} {CreateStreamRequest}

  * _callback_: {Function} Optional. Callback function





### getStreamsEnabled([callback])



Get a list of all enabled streams



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStreamThroughput(parameters, path[, callback])



Current throughput of this stream on this node in messages per second



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### getStreamAllThroughput([callback])



Current throughput of all visible streams on this node in messages per second



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStream(parameters, path[, callback])



Get a single stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### updateStream(parameters, path[, callback])



Update a stream



__Arguments__:

  * __parameters__: {Object} {UpdateStreamRequest}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeStream(parameters, path[, callback])



Delete a stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### cloneStream(parameters, path[, callback])



Clone a stream



__Arguments__:

  * __parameters__: {Object} {CloneStreamRequest}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### pauseStream(parameters, path[, callback])



Pause a stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### resumeStream(parameters, path[, callback])



Resume a stream



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function





### testMatchStream(parameters, path[, callback])



Test matching of a stream against a supplied message



__Arguments__:

  * __parameters__: {Object} {Map}

  * __path__: {Object}

    * __streamId__: {String}

  * _callback_: {Function} Optional. Callback function



## System: System information of this node





### getSystem([callback])



Get system overview



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getJVM([callback])



Get JVM information



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getThreadDump([callback])



Get a thread dump



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Buffers: Buffer information of this node.





### getBuffers([callback])



Get current utilization of buffers and caches of this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getBuffersClasses([callback])



Get classnames of current buffer implementations



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Bundles: Content packs





### createBundle(parameters[, callback])



Upload a content pack



__Arguments__:

  * __parameters__: {Object}

    * __Request__ body {ConfigurationBundle} Content pack

  * _callback_: {Function} Optional. Callback function





### getBundles([callback])



List available content packs



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### exportBundles(parameters[, callback])



Export entities as a content pack



__Arguments__:

  * __parameters__: {Object}

    * __exportBundle__: {ExportBundle} Export content pack

  * _callback_: {Function} Optional. Callback function





### getBundle(parameters, path[, callback])



Show content pack



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __bundleId__: {String} Content pack ID

  * _callback_: {Function} Optional. Callback function





### updateBundle(parameters, path[, callback])



Update content pack



__Arguments__:

  * __parameters__: {Object}

    * __Request__ body {ConfigurationBundle} Content pack

  * __path__: {Object}

    * __bundleId__: {String} Content pack ID

  * _callback_: {Function} Optional. Callback function





### removeBundle(parameters, path[, callback])



Delete content pack



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __bundleId__: {String} Content pack ID

  * _callback_: {Function} Optional. Callback function





### applyBundle(parameters, path[, callback])



Set up entities described by content pack



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __bundleId__: {String} Content pack ID

  * _callback_: {Function} Optional. Callback function



## System/Cluster: Node discovery





### getNodeThis([callback])



Information about this node



This  de itself to get system information



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getNodes(parameters, path[, callback])



List all active nodes in this cluster



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __nodeId__: {String}

  * _callback_: {Function} Optional. Callback function





### getNode(parameters, path[, callback])



Information about a node



This is returning information of a node in context to its state in the cluster. Use the system API of the node itself to get system information



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __nodeId__: {String}

  * _callback_: {Function} Optional. Callback function



## System/ClusterStats: Cluster stats





### getClusterStats([callback])



Cluster snformation



This resource returns information about the Graylog cluster



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getClusterStatsElasticsearch([callback])



Elasticsearch information



This resource returns information about the Elasticsearch Cluster



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getClusterStatsMongo([callback])



MongoDB information



This aut MongoDB



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Collectors: Management of Graylog Collectors





### getSystemCollectors([callback])



Lists all existing collector registrations



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getSystemCollector(parameters, path[, callback])



Returns at most one collector summary for the specified collector id



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __collectorId__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Collectors/Registration: Registration resource for Graylog Collector nodes





### changeCollector(parameters, path[, callback])



Create/update an collector registration



This is a stateless method which upserts a collector registration



__Arguments__:

  * __parameters__: {Object} {CollectorRegistrationRequest}

  * __path__: {Object}

    * __collectorId__: {String} The collector id this collector is registering as

  * _callback_: {Function} Optional. Callback function



## System/Debug/Events: For debugging local and cluster events.





### createDebugEventsCluster(parameters[, callback])



Create and send a cluster debug event



__Arguments__:

  * __parameters__: {Object}

    * _text_: {String} Optional.

  * _callback_: {Function} Optional. Callback function





### getDebugEventsCluster([callback])



Show last received cluster debug event



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### createDebugEventsLocal(parameters[, callback])



Create and send a local debug event



__Arguments__:

  * __parameters__: {Object}

    * _text_: {String} Optional.

  * _callback_: {Function} Optional. Callback function





### getDebugEventsLocal([callback])



Show last received local debug event



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Deflector: Index deflector management





### getDeflector([callback])



Get current deflector status



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getDeflectorConfig([callback])



Get deflector configuration. Only available on master nodes



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### nextDeflectorCycle([callback])



Cycle deflector to new/next index



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Fields: Get list of message fields that exist.





### getFields(parameters[, callback])



Get list of message fields that exist



This operation is comparably fast because it reads directly from the indexer mapping



__Arguments__:

  * __parameters__: {Object}

    * _limit_: {Integer} Optional. Maximum number of fields to return. Set to 0 for all fields

  * _callback_: {Function} Optional. Callback function



## System/Grok: Manage grok patterns





### getGroks([callback])



Get all existing grok patterns



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getGrok(parameters, path[, callback])



Get the existing grok pattern



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __patternId__: {String}

  * _callback_: {Function} Optional. Callback function





### createGrok(parameters[, callback])



Add a new named pattern



__Arguments__:

  * __parameters__: {Object}

    * __pattern__: {GrokPatternSummary}

  * _callback_: {Function} Optional. Callback function





### createGroks(parameters[, callback])



Update an existing pattern



__Arguments__:

  * __parameters__: {Object}

    * __patterns__: {Array}

  * _callback_: {Function} Optional. Callback function





### updateGrok(parameters, path[, callback])



Update an existing pattern



__Arguments__:

  * __parameters__: {Object}

    * __pattern__: {GrokPatternSummary}

  * __path__: {Object}

    * __patternId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeGrok([callback])



Remove an existing pattern by id



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/IndexRanges: Index timeranges





### getIndicesRanges([callback])



Get a list of all index ranges



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### rebuildIndicesRanges([callback])



Rebuild/sync index range information



This as in what timeranges. It atomically overwrites already existing meta information



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Inputs: Message inputs of this node





### createInput(parameters[, callback])



Launch input on this node



__Arguments__:

  * __parameters__: {Object} {InputLaunchRequest}

  * _callback_: {Function} Optional. Callback function





### getInput(null, path[, callback])



Get information of a single input on this node



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### getInputs([callback])



Get all inputs of this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### updateInput(parameters, path[, callback])



Update input on this node



__Arguments__:

  * __parameters__: {Object} {InputLaunchRequest}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeInput(parameters, path[, callback])



Terminate input on this node



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### launchInput(parameters, path[, callback])



Launch existing input on this node



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### restartInput(parameters, path[, callback])



Restart existing input on this node



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### stopInput(parameters, path[, callback])



Stop existing input on this node



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Inputs/Types: Message input types of this node





### getInputsType(parameters, path[, callback])



Get information about a single input type



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __inputType__: {String}

  * _callback_: {Function} Optional. Callback function





### getInputsTypes([callback])



Get all available input types of this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Jobs: System Jobs





### createJob(parameters[, callback])



Trigger new job



__Arguments__:

  * __parameters__: {Object} {TriggerRequest}

  * _callback_: {Function} Optional. Callback function





### getJobs([callback])



List currently running jobs



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getJob(parameters, path[, callback])



Get information of a specific currently running job



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __jobId__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Journal: Message journal information of this node.





### getJournal([callback])



Get current state of the journal on this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/LDAP: LDAP settings





### getLDAPSettings([callback])



Get the LDAP configuration if it is configured



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### updateLDAPSettings(parameters[, callback])



Update the LDAP configuration



__Arguments__:

  * __parameters__: {Object} {LdapSettingsRequest}

  * _callback_: {Function} Optional. Callback function





### removeLDAPSettings([callback])



Remove the LDAP configuration



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### testLDAPSettings(parameters[, callback])



Test LDAP Configuration



__Arguments__:

  * __parameters__: {Object}

    * __Configuration__ to test {LdapTestConfigRequest}

  * _callback_: {Function} Optional. Callback function



## System/LoadBalancers: Status propagation for load balancers





### getLoadBalancerStatus([callback])



Get status of this graylog2-server node for load balancers. Returns either ALIVE with HTTP 200 or DEAD with HTTP 503



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### updateLoadBalancerStatusOverride(parameters, path[, callback])



Override load balancer status of this graylog2-server node. Next lifecycle change will override it again to its default. Set to ALIVE or DEAD



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * _status_: {String} Optional.

  * _callback_: {Function} Optional. Callback function



## System/Loggers: Internal Graylog loggers





### getLoggers([callback])



List all loggers and their current levels



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getLoggersSubsystems([callback])



List all logger subsystems and their current levels



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### setLoggersSubsystemsLevel(parameters, path[, callback])



Set the loglevel of a whole subsystem



Provided level is falling back to DEBUG if it does not exist



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __subsystem__: {String}

    * __level__: {String}

  * _callback_: {Function} Optional. Callback function





### setLoggersLevel(parameters, path[, callback])



Set the loglevel of a single logger



Provided level is falling back to DEBUG if it does not exist



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __loggerName__: {String}

    * __level__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Messages: Internal Graylog messages





### getSystemMessages(parameters[, callback])



Get internal Graylog system messages



__Arguments__:

  * __parameters__: {Object}

    * _page_: {Integer} Optional. Page

  * _callback_: {Function} Optional. Callback function



## System/Metrics: Internal Graylog2 metrics





### getMetric(parameters, path[, callback])



Get a single metric



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __metricName__: {String}

  * _callback_: {Function} Optional. Callback function





### getMetrics([callback])



Get all metrics



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getMetricsMultiple(parameters[, callback])



Get the values of multiple metrics at once



__Arguments__:

  * __parameters__: {Object}

    * __Requested__ metrics {MetricsReadRequest}

  * _callback_: {Function} Optional. Callback function





### getMetricsNames([callback])



Get all metrics keys/names



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getMetricsNamespace(parameters, path[, callback])



Get all metrics of a namespace



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __namespace__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Metrics/History: Get history of metrics





### getMetricsHistory(parameters, path[, callback])



Get history of a single metric

The maximum retention time is currently only 5 minutes



__Arguments__:

  * __parameters__: {Object}

    * _after_: {Long} Optional. Only values for after this UTC timestamp (1970 epoch)

  * __path__: {Object}

    * __metricName__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Notifications: Notifications generated by the system





### getNotifications([callback])



Get all active notifications



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### removeNotification(parameters, path[, callback])



Delete a notification



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * _notificationType_: {String} Optional.

  * _callback_: {Function} Optional. Callback function



## System/Outputs: Manage outputs





### getOutput(parameters, path[, callback])



Get specific output



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __outputId__: {String} The id of the output we want

  * _callback_: {Function} Optional. Callback function





### getOutputs([callback])



Get a list of all outputs



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### createOutput(parameters[, callback])



Create an output



__Arguments__:

  * __parameters__: {Object} {CreateOutputRequest}

  * _callback_: {Function} Optional. Callback function





### getOutputsAvailable([callback])



Get all available output modules



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### updateOutput(parameters, path[, callback])



Update output



__Arguments__:

  * __parameters__: {Object} {Map}

  * __path__: {Object}

    * __outputId__: {String} The id of the output that should be deleted

  * _callback_: {Function} Optional. Callback function





### removeOutput(parameters, path[, callback])



Delete output



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __outputId__: {String} The id of the output that should be deleted

  * _callback_: {Function} Optional. Callback function



## System/Permissions: Retrieval of system permissions





### getPermissions([callback])



Get all available user permissions



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getPermissionsReader(parameters, path[, callback])



Get the initial permissions assigned to a reader account



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Plugin: Plugin information





### getSystemPlugins([callback])



List all installed plugins on this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Processing: System processing status control





### pauseSystemProcessing([callback])



Pauses message processing



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### resumeSystemProcessing([callback])



Resume message processing



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Radios: Management of graylog2-radio nodes





### getRadio(parameters, path[, callback])



Information about a radio



This is returning information of a radio in context to its state in the cluster. Use the system API of the node itself to get system information



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __radioId__: {String}

  * _callback_: {Function} Optional. Callback function





### getRadios([callback])



List all active radios in this cluster



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### createRadioInput(parameters, path[, callback])



Register input of a radio



Radio inputs register their own inputs here for persistence after they successfully launched it



__Arguments__:

  * __parameters__: {Object} {RegisterInputRequest}

  * __path__: {Object}

    * __radioId__: {String}

  * _callback_: {Function} Optional. Callback function





### getRadioInputs(parameters, path[, callback])



Persisted inputs of a radio



This is returning the configured persisted inputs of a radio node. This is *not* returning the actually running inputs on a radio node. Radio nodes use this resource to get their configured inputs on startup



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __radioId__: {String}

  * _callback_: {Function} Optional. Callback function





### removeRadioInput(parameters, path[, callback])



Unregister input of a radio



Radios unregister their inputs when they are stopped/terminated on the radio



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __radioId__: {String}

    * __inputId__: {String}

  * _callback_: {Function} Optional. Callback function





### pingRadio(parameters, path[, callback])



Ping - Accepts pings of graylog2-radio nodes



Every graylog2-radio node is regularly pinging to announce that it is active



__Arguments__:

  * __parameters__: {Object} {PingRequest}

  * __path__: {Object}

    * __radioId__: {String}

  * _callback_: {Function} Optional. Callback function



## System/ServiceManager: ServiceManager Status





### getServiceManager([callback])



List current status of ServiceManager



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Sessions: Login for interactive user sessions





### createSession(parameters[, callback])



This request creates a new session for a user or reactivates an existing session: the equivalent of logging in



__Arguments__:

  * __parameters__: {Object}

    * __Login__ request {SessionCreateRequest} Username and credentials

  * _callback_: {Function} Optional. Callback function





### removeSession(parameters, path[, callback])



Terminate an existing session



Destroys the session with the given ID: the equivalent of logging out



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __sessionId__: {String}

  * _callback_: {Function} Optional. Callback function



## System/Shutdown: Shutdown this node gracefully





### shutdownNode([callback])



Shutdown this node gracefully



Attempts  at no new messages are accepted



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Stats: Node system stats





### getStats([callback])



System o this node



This resource returns information about the system this node is running on



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStatsFs([callback])



Filesystem o this node



This resource returns information about the filesystems of this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStatsJvm([callback])



JVM information o this node



This resource returns information about the Java Virtual Machine of this node



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStatsNetwork([callback])



Networking o this node



This resource returns information about the networking system this node is running with



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStatsOs([callback])



OS information o this node



This resource returns information about the operating system this node is running on



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### getStatsProcess([callback])



Process information about this node



This irunning as



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## System/Throughput: Message throughput of this node





### getThroughput([callback])



Current throughput of this node in messages per second



__Arguments__:

  * _callback_: {Function} Optional. Callback function



## Users: User accounts





### getUser(parameters, path[, callback])



Get user details



The user's permissions are only included if a user asks for his own account or for users with the necessary permissions to edit permissions



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String} The username to return information for

  * _callback_: {Function} Optional. Callback function





### getUsers([callback])



Lurs



The permissions assigned to the users are always included



__Arguments__:

  * _callback_: {Function} Optional. Callback function





### createUser(parameters[, callback])



Create a new user account



__Arguments__:

  * __parameters__: {Object} {CreateUserRequest} Must contain username, full_name, email, password and a list of permissionsteUserRequest'

  * _callback_: {Function} Optional. Callback function





### updateUser(parameters, path[, callback])



Modify user details



__Arguments__:

  * __parameters__: {Object} {ChangeUserRequest} Updated user information

  * __path__: {Object}

    * __username__: {String} The name of the user to modify

  * _callback_: {Function} Optional. Callback function





### removeUser(parameters, path[, callback])



Removes a user account



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String} The name of the user to delete

  * _callback_: {Function} Optional. Callback function





### updateUserPassword(parameters, path[, callback])



Update the password for a user



__Arguments__:

  * __parameters__: {Object} {ChangePasswordRequest} The old and new passwords

  * __path__: {Object}

    * __username__: {String} The name of the user whose password to change

  * _callback_: {Function} Optional. Callback function





### updateUserPermissions(parameters, path[, callback])



Update a user's permission set



__Arguments__:

  * __parameters__: {Object} {PermissionEditRequest} The list of permissions to assign to the user

  * __path__: {Object}

    * __username__: {String} The name of the user to modify

  * _callback_: {Function} Optional. Callback function





### removeUserPermissions(parameters, path[, callback])



Revoke all permissions for a user without deleting the account



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String} The name of the user to modify

  * _callback_: {Function} Optional. Callback function





### updateUserPreferences(parameters, path[, callback])



Update a user's preferences set



__Arguments__:

  * __parameters__: {Object} {UpdateUserPreferences} The map of preferences to assign to the user

  * __path__: {Object}

    * __username__: {String} The name of the user to modify

  * _callback_: {Function} Optional. Callback function





### getUserTokens(parameters, path[, callback])



Retrieves the list of access tokens for a user



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String}

  * _callback_: {Function} Optional. Callback function





### createUserToken(parameters, path[, callback])



Generates a new access token for a user



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String}

    * __name__: {String} Descriptive name for this token (e.g. "cronjob")

  * _callback_: {Function} Optional. Callback function





### removeUserToken(parameters, path[, callback])



Removes a token for a user



__Arguments__:

  * __parameters__: {null}

  * __path__: {Object}

    * __username__: {String}

    * __access__: token {String}

  * _callback_: {Function} Optional. Callback function



## License



The MIT License (MIT)



Copyright (c) 2015 Andrii Kolomiichenko ([email protected])



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.