{"id":19984997,"url":"https://github.com/kolomiichenko/graylog-api","last_synced_at":"2025-05-04T06:34:00.956Z","repository":{"id":35408958,"uuid":"39673563","full_name":"kolomiichenko/graylog-api","owner":"kolomiichenko","description":"Node.js module for Graylog2 API","archived":false,"fork":false,"pushed_at":"2024-04-11T12:15:09.000Z","size":70,"stargazers_count":18,"open_issues_count":3,"forks_count":23,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T01:13:59.836Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kolomiichenko.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-07-25T05:21:52.000Z","updated_at":"2024-09-16T14:21:42.000Z","dependencies_parsed_at":"2024-06-21T07:26:35.223Z","dependency_job_id":"ad1738db-ee10-4f39-96c1-ede313cbe573","html_url":"https://github.com/kolomiichenko/graylog-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolomiichenko%2Fgraylog-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolomiichenko%2Fgraylog-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolomiichenko%2Fgraylog-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kolomiichenko%2Fgraylog-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kolomiichenko","download_url":"https://codeload.github.com/kolomiichenko/graylog-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224387100,"owners_count":17302784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T04:21:48.531Z","updated_at":"2024-11-13T04:21:49.135Z","avatar_url":"https://github.com/kolomiichenko.png","language":"JavaScript","readme":"# graylog-api\n\nNode.js module for Graylog2 API.\n\nAll methods of this module compatitible with Graylog API v1.1.4 (59783f6).\nSearch syntax look here: [The search query language](http://docs.graylog.org/en/latest/pages/queries.html).\nFor more detail you can look Graylog REST API browser: [localhost:12900/api-browser](http://localhost:12900/api-browser).\n\n## Quick examples\n\n```javascript\nvar graylog = require('graylog-api');\nvar api = graylog.connect({\n  basicAuth: {\n    username: 'admin',\n    password: 'secret'\n  }, // Optional. Default: null. Basic access authentication\n  protocol: 'https', // Optional. Default: 'http'. Connection protocol\n  host: 'example.com', // Optional. Default: 'localhost'. API hostname\n  port: '12900', // Optional. Default: '12900'. API port\n  path: '/api' // Optional. Default: ''. API Path\n});\n\napi.searchAbsolute({ // parameters\n  query: 'source:apache',\n  from: '2015-07-24T00:00:00.000Z',\n  to: '2015-07-25T00:00:00.000Z',\n  limit: '10',\n  fields: 'message,timestamp',\n  sort: 'asc'\n}, function(err, data) { // callback\n  if (err) {\n    console.log(err);\n  } else {\n    console.log(data);\n  }\n});\n\nupdateUserPassword({ // parameters\n  old_password: 'secret',\n  password: 'qwerty123'\n}, { // path\n  username: 'admin'\n}, function (err, data) { // callback\n  if (err) {\n    console.log(err);\n  } else {\n    console.log(data);\n  }\n});\n\napi.getSystem(function(err, data) {  // only callback\n  if (!err) {\n    console.log(data);\n  }\n});\n```\n\n## Download\n\nThe source is available for download from\n[GitHub](https://github.com/kolomiichenko/graylog-api).\nAlternatively, you can install using Node Package Manager (`npm`):\n\n```bash\n  npm install graylog-api\n```\n\n## Documentation\n\nAPI object expression has the same this syntax:\n\n```javascript\napi.[methodName]([parameters][, path][, callback]);\n```\n\n* `methodName` - The method name\n* `parameters` - Object of method to be passed to the API server\n* `path` - Optional object of method to be replace path variables\n* `callback` - Optional function to be call it after receive api data. First argument is object of error (`null` if no errors), second - data\n\n## Methods\n\n### AlarmCallbacks: Manage stream alarm callbacks\n* [`getAlarmCallbacks`](#getAlarmCallbacks)\n* [`createAlarmCallback`](#createAlarmCallback)\n* [`getAlarmCallbacksAvailable`](#getAlarmCallbacksAvailable)\n* [`getAlarmCallback`](#getAlarmCallback)\n* [`updateAlarmCallback`](#updateAlarmCallback)\n* [`removeAlarmCallback`](#removeAlarmCallback)\n\n### AlertConditions: Manage stream alert conditions\n* [`createAlertCondition`](#createAlertCondition)\n* [`getAlertConditions`](#getAlertConditions)\n* [`updateAlertCondition`](#updateAlertCondition)\n* [`removeAlertCondition`](#removeAlertCondition)\n\n### AlertReceivers: Manage stream alert receivers\n* [`getAlerts`](#getAlerts)\n* [`getAlertsCheck`](#getAlertsCheck)\n* [`createAlertReceiver`](#createAlertReceiver)\n* [`removeAlertReceiver`](#removeAlertReceiver)\n* [`testAlertSendDummy`](#testAlertSendDummy)\n\n### Alerts: Manage stream alerts\n* [`getAlerts`](#getAlerts)\n* [`getAlertsCheck`](#getAlertsCheck)\n* [`createAlertReceiver`](#createAlertReceiver)\n* [`removeAlertReceiver`](#removeAlertReceiver)\n* [`testAlertSendDummy`](#testAlertSendDummy)\n\n### Counts: Message counts\n* [`getCountTotal`](#getCountTotal)\n\n### Dashboards: Manage dashboards\n* [`createDashboard`](#createDashboard)\n* [`getDashboards`](#getDashboards)\n* [`getDashboard`](#getDashboard)\n* [`updateDashboard`](#updateDashboard)\n* [`removeDashboard`](#removeDashboard)\n* [`updateDashboardPositions`](#updateDashboardPositions)\n* [`createDashboardWidget`](#createDashboardWidget)\n* [`updateDashboardWidget`](#updateDashboardWidget)\n* [`removeDashboardWidget`](#removeDashboardWidget)\n* [`updateDashboardWidgetCacheTime`](#updateDashboardWidgetCacheTime)\n* [`updateDashboardWidgetDescription`](#updateDashboardWidgetDescription)\n* [`getDashboardWidgetValue`](#getDashboardWidgetValue)\n\n### Extractors: Extractors of an input\n* [`createInputExtractor`](#createInputExtractor)\n* [`getInputExtractors`](#getInputExtractors)\n* [`updateInputExtractorOrder`](#updateInputExtractorOrder)\n* [`updateInputExtractor`](#updateInputExtractor)\n* [`removeInputExtractor`](#removeInputExtractor)\n* [`getInputExtractor`](#getInputExtractor)\n\n### Filters: Message blacklist filters\n* [`createBlacklistFilter`](#createBlacklistFilter)\n* [`getBlacklistFilters`](#getBlacklistFilters)\n* [`getBlacklistFilter`](#getBlacklistFilter)\n* [`updateBlacklistFilter`](#updateBlacklistFilter)\n* [`removeBlacklistFilter`](#removeBlacklistFilter)\n\n### Indexer/Cluster: Indexer cluster information\n* [`getClusterHealth`](#getClusterHealth)\n* [`getClusterName`](#getClusterName)\n\n### Indexer/Failures: Indexer failures\n* [`getSystemFailures`](#getSystemFailures)\n* [`getFailuresCount`](#getFailuresCount)\n\n### Indexer/Indices: Index information\n* [`getIndicesClosed`](#getIndicesClosed)\n* [`getIndicesReopened`](#getIndicesReopened)\n* [`removeIndex`](#removeIndex)\n* [`getIndices`](#getIndices)\n* [`closeIndex`](#closeIndex)\n* [`reopenIndex`](#reopenIndex)\n\n### Messages: Single messages\n* [`analyzeMessage`](#analyzeMessage)\n* [`getMessage`](#getMessage)\n\n### Search/Absolute: Message search\n* [`searchAbsolute`](#searchAbsolute)\n* [`searchAbsoluteFieldHistogram`](#searchAbsoluteFieldHistogram)\n* [`searchAbsoluteHistogram`](#searchAbsoluteHistogram)\n* [`searchAbsoluteStats`](#searchAbsoluteStats)\n* [`searchAbsoluteTerms`](#searchAbsoluteTerms)\n* [`searchAbsoluteTermsStats`](#searchAbsoluteTermsStats)\n\n### Search/Keyword: Message search\n* [`searchKeyword`](#searchKeyword)\n* [`searchKeywordFieldHistogram`](#searchKeywordFieldHistogram)\n* [`searchKeywordHistogram`](#searchKeywordHistogram)\n* [`searchKeywordStats`](#searchKeywordStats)\n* [`searchKeywordTerms`](#searchKeywordTerms)\n* [`searchKeywordTermsStats`](#searchKeywordTermsStats)\n\n### Search/Relative: Message search\n* [`searchRelative`](#searchRelative)\n* [`searchRelativeFieldHistogram`](#searchRelativeFieldHistogram)\n* [`searchRelativeHistogram`](#searchRelativeHistogram)\n* [`searchRelativeStats`](#searchRelativeStats)\n* [`searchRelativeTerms`](#searchRelativeTerms)\n* [`searchRelativeTermsStats`](#searchRelativeTermsStats)\n\n### Search/Saved: Saved searches\n* [`createSearchSaved`](#createSearchSaved)\n* [`getSearchSavedAll`](#getSearchSavedAll)\n* [`getSearchSaved`](#getSearchSaved)\n* [`updateSearchSaved`](#updateSearchSaved)\n* [`removeSearchSaved`](#removeSearchSaved)\n\n### Sources: Listing message sources (e.g. hosts sending logs)\n* [`getSources`](#getSources)\n\n### StaticFields: Static fields of an input\n* [`createInputStaticField`](#createInputStaticField)\n* [`removeInputStaticField`](#removeInputStaticField)\n\n### StreamOutputs: Manage stream outputs for a given stream\n* [`createStreamOutput`](#createStreamOutput)\n* [`getStreamOutputs`](#getStreamOutputs)\n* [`getStreamOutput`](#getStreamOutput)\n* [`removeStreamOutput`](#removeStreamOutput)\n\n### StreamRules: Manage stream rules\n* [`getStreamRules`](#getStreamRules)\n* [`getStreamRule`](#getStreamRule)\n* [`createStreamRule`](#createStreamRule)\n* [`updateStreamRule`](#updateStreamRule)\n* [`removeStreamRule`](#removeStreamRule)\n\n\n### Streams: Manage streams\n* [`getStreams`](#getStreams)\n* [`createStream`](#createStream)\n* [`getStreamsEnabled`](#getStreamsEnabled)\n* [`getStreamThroughput`](#getStreamThroughput)\n* [`getStreamAllThroughput`](#getStreamAllThroughput)\n* [`getStream`](#getStream)\n* [`updateStream`](#updateStream)\n* [`removeStream`](#removeStream)\n* [`cloneStream`](#cloneStream)\n* [`pauseStream`](#pauseStream)\n* [`resumeStream`](#resumeStream)\n* [`testMatchStream`](#testMatchStream)\n\n### System: System information of this node\n* [`getSystem`](#getSystem)\n* [`getJVM`](#getJVM)\n* [`getThreadDump`](#getThreadDump)\n\n### System/Buffers: Buffer information of this node.\n* [`getBuffers`](#getBuffers)\n* [`getBuffersClasses`](#getBuffersClasses)\n\n### System/Bundles: Content packs\n* [`createBundle`](#createBundle)\n* [`getBundles`](#getBundles)\n* [`exportBundles`](#exportBundles)\n* [`getBundle`](#getBundle)\n* [`updateBundle`](#updateBundle)\n* [`removeBundle`](#removeBundle)\n* [`applyBundle`](#applyBundle)\n\n### System/Cluster: Node discovery\n* [`getNodeThis`](#getNodeThis)\n* [`getNodes`](#getNodes)\n* [`getNode`](#getNode)\n\n### System/ClusterStats: Cluster stats\n* [`getClusterStats`](#getClusterStats)\n* [`getClusterStatsElasticsearch`](#getClusterStatsElasticsearch)\n* [`getClusterStatsMongo`](#getClusterStatsMongo)\n\n### System/Collectors: Management of Graylog Collectors\n* [`getSystemCollectors`](#getSystemCollectors)\n* [`getSystemCollector`](#getSystemCollector)\n\n### System/Collectors/Registration: Registration resource for Graylog Collector nodes\n* [`changeCollector`](#changeCollector)\n\n### System/Debug/Events: For debugging local and cluster events.\n* [`createDebugEventsCluster`](#createDebugEventsCluster)\n* [`getDebugEventsCluster`](#getDebugEventsCluster)\n* [`createDebugEventsLocal`](#createDebugEventsLocal)\n* [`getDebugEventsLocal`](#getDebugEventsLocal)\n\n### System/Deflector: Index deflector management\n* [`getDeflector`](#getDeflector)\n* [`getDeflectorConfig`](#getDeflectorConfig)\n* [`nextDeflectorCycle`](#nextDeflectorCycle)\n\n\n### System/Fields: Get list of message fields that exist.\n* [`getFields`](#getFields)\n\n### System/Grok: Manage grok patterns\n* [`getGroks`](#getGroks)\n* [`getGrok`](#getGrok)\n* [`createGrok`](#createGrok)\n* [`createGroks`](#createGroks)\n* [`updateGrok`](#updateGrok)\n* [`removeGrok`](#removeGrok)\n\n### System/IndexRanges: Index timeranges\n* [`getIndicesRanges`](#getIndicesRanges)\n* [`rebuildIndicesRanges`](#rebuildIndicesRanges)\n\n### System/Inputs: Message inputs of this node\n* [`createInput`](#createInput)\n* [`getInput`](#getInput)\n* [`getInputs`](#getInputs)\n* [`updateInput`](#updateInput)\n* [`removeInput`](#removeInput)\n* [`launchInput`](#launchInput)\n* [`restartInput`](#restartInput)\n* [`stopInput`](#stopInput)\n\n### System/Inputs/Types: Message input types of this node\n* [`getInputsType`](#getInputsType)\n* [`getInputsTypes`](#getInputsTypes)\n\n### System/Jobs: System Jobs\n* [`createJob`](#createJob)\n* [`getJobs`](#getJobs)\n* [`getJob`](#getJob)\n\n### System/Journal: Message journal information of this node.\n* [`getJournal`](#getJournal)\n\n### System/LDAP: LDAP settings\n* [`getLDAPSettings`](#getLDAPSettings)\n* [`updateLDAPSettings`](#updateLDAPSettings)\n* [`removeLDAPSettings`](#removeLDAPSettings)\n* [`testLDAPSettings`](#testLDAPSettings)\n\n### System/LoadBalancers: Status propagation for load balancers\n* [`getLoadBalancerStatus`](#getLoadBalancerStatus)\n* [`updateLoadBalancerStatusOverride`](#updateLoadBalancerStatusOverride)\n\n### System/Loggers: Internal Graylog loggers\n* [`getLoggers`](#getLoggers)\n* [`getLoggersSubsystems`](#getLoggersSubsystems)\n* [`setLoggersSubsystemsLevel`](#setLoggersSubsystemsLevel)\n* [`setLoggersLevel`](#setLoggersLevel)\n\n### System/Messages: Internal Graylog messages\n* [`getSystemMessages`](#getSystemMessages)\n\n### System/Metrics: Internal Graylog2 metrics\n* [`getMetric`](#getMetric)\n* [`getMetrics`](#getMetrics)\n* [`getMetricsMultiple`](#getMetricsMultiple)\n* [`getMetricsNames`](#getMetricsNames)\n* [`getMetricsNamespace`](#getMetricsNamespace)\n\n### System/Metrics/History: Get history of metrics\n* [`getMetricsHistory`](#getMetricsHistory)\n\n### System/Notifications: Notifications generated by the system\n* [`getNotifications`](#getNotifications)\n* [`removeNotification`](#removeNotification)\n\n### System/Outputs: Manage outputs\n* [`getOutput`](#getOutput)\n* [`getOutputs`](#getOutputs)\n* [`createOutput`](#createOutput)\n* [`getOutputsAvailable`](#getOutputsAvailable)\n* [`updateOutput`](#updateOutput)\n* [`removeOutput`](#removeOutput)\n\n### System/Permissions: Retrieval of system permissions\n* [`getPermissions`](#getPermissions)\n* [`getPermissionsReader`](#getPermissionsReader)\n\n### System/Plugin: Plugin information\n* [`getSystemPlugins`](#getSystemPlugins)\n\n### System/Processing: System processing status control\n* [`pauseSystemProcessing`](#pauseSystemProcessing)\n* [`resumeSystemProcessing`](#resumeSystemProcessing)\n\n### System/Radios: Management of graylog2-radio nodes\n* [`getRadio`](#getRadio)\n* [`getRadios`](#getRadios)\n* [`createRadioInput`](#createRadioInput)\n* [`getRadioInputs`](#getRadioInputs)\n* [`removeRadioInput`](#removeRadioInput)\n* [`pingRadio`](#pingRadio)\n\n### System/ServiceManager: ServiceManager Status\n* [`getServiceManager`](#getServiceManager)\n\n### System/Sessions: Login for interactive user sessions\n* [`createSession`](#createSession)\n* [`removeSession`](#removeSession)\n\n### System/Shutdown: Shutdown this node gracefully\n* [`shutdownNode`](#shutdownNode)\n\n### System/Stats: Node system stats\n* [`getStats`](#getStats)\n* [`getStatsFs`](#getStatsFs)\n* [`getStatsJvm`](#getStatsJvm)\n* [`getStatsNetwork`](#getStatsNetwork)\n* [`getStatsOs`](#getStatsOs)\n* [`getStatsProcess`](#getStatsProcess)\n\n### System/Throughput: Message throughput of this node\n* [`getThroughput`](#getThroughput)\n\n### Users: User accounts\n* [`getUser`](#getUser)\n* [`getUsers`](#getUsers)\n* [`createUser`](#createUser)\n* [`updateUser`](#updateUser)\n* [`removeUser`](#removeUser)\n* [`updateUserPassword`](#updateUserPassword)\n* [`updateUserPermissions`](#updateUserPermissions)\n* [`removeUserPermissions`](#removeUserPermissions)\n* [`updateUserPreferences`](#updateUserPreferences)\n* [`getUserTokens`](#getUserTokens)\n* [`createUserToken`](#createUserToken)\n* [`removeUserToken`](#removeUserToken)\n\n## AlarmCallbacks: Manage stream alarm callbacks\n\n\u003ca name=\"getAlarmCallbacks\"\u003e\n### getAlarmCallbacks(parameters, path[, callback])\n\nGet a list of all alarm callbacks for this stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose alarm callbacks we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createAlarmCallback\"\u003e\n### createAlarmCallback(parameters, path[, callback])\n\nCreate an alarm callback\n\n__Arguments__:\n  * __parameters__: {Object} {CreateAlarmCallbackRequest}\n  * __path__: {Object}\n    * __streamid__: {String} The stream id this new alarm callback belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getAlarmCallbacksAvailable\"\u003e\n### getAlarmCallbacksAvailable(parameters, path[, callback])\n\nGet a list of all alarm callback types\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose alarm callbacks we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getAlarmCallback\"\u003e\n### getAlarmCallback(parameters, path[, callback])\n\nGet a single specified alarm callback for this stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose alarm callbacks we want\n    * __alarmCallbackId__: {String} The alarm callback id we are getting\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateAlarmCallback\"\u003e\n### updateAlarmCallback(parameters, path[, callback])\n\nUpdate an alarm callback\n\n__Arguments__:\n  * __parameters__: {Object} {Map}\n  * __path__: {Object}\n    * __streamid__: {String} The stream id this alarm callback belongs to\n    * __alarmCallbackId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeAlarmCallback\"\u003e\n### removeAlarmCallback(parameters, path[, callback])\n\nDelete an alarm callback\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The stream id this alarm callback belongs to\n    * __alarmCallbackId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## AlertConditions: Manage stream alert conditions\n\n\u003ca name=\"createAlertCondition\"\u003e\n### createAlertCondition(parameters, path[, callback])\n\nCreate an alert condition\n\n__Arguments__:\n  * __parameters__: {Object} {CreateConditionRequest}\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getAlertConditions\"\u003e\n### getAlertConditions(parameters, path[, callback])\n\nGet all alert conditions of this stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateAlertCondition\"\u003e\n### updateAlertCondition(parameters, path[, callback])\n\nModify an alert condition\n\n__Arguments__:\n  * __parameters__: {Object} {CreateConditionRequest}\n  * __path__: {Object}\n    * __streamId__: {String} The stream id the alert condition belongs to\n    * __conditionId__: {String} The alert condition id\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeAlertCondition\"\u003e\n### removeAlertCondition(parameters, path[, callback])\n\nDelete an alert condition\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n    * __conditionId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n## AlertReceivers: Manage stream alert receivers\n\n\u003ca name=\"getAlerts\"\u003e\n### getAlerts(parameters, path[, callback])\n\nGet the 300 most recent alarms of this stream\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _since_: {Integer} Optional. Optional parameter to define a lower date boundary. (UNIX timestamp)\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getAlertsCheck\"\u003e\n### getAlertsCheck(parameters, path[, callback])\n\nCheck for triggered alert conditions of this streams. Results cached for 30 seconds\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String} The ID of the stream to check\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createAlertReceiver\"\u003e\n### createAlertReceiver(parameters, path[, callback])\n\nAdd an alert receiver\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __entity__: {String} Name/ID of user or email address to add as alert receiver\n    * __type__: {String} Type: users or emails\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeAlertReceiver\"\u003e\n### removeAlertReceiver(parameters, path[, callback])\n\nRemove an alert receiver\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __type__: {String} Type: users or emails\n    * __entity__: {String} Name/ID of user or email address to remove from alert receivers\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"testAlertSendDummy\"\u003e\n### testAlertSendDummy(parameters, path[, callback])\n\nSend a test mail for a given stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n## Alerts: Manage stream alerts\n\n\u003ca name=\"getAlerts\"\u003e\n### getAlerts(parameters, path[, callback])\n\nGet the 300 most recent alarms of this stream\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _since_: {Integer} Optional. Optional parameter to define a lower date boundary. (UNIX timestamp)\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getAlertsCheck\"\u003e\n### getAlertsCheck(parameters, path[, callback])\n\nCheck for triggered alert conditions of this streams. Results cached for 30 seconds\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String} The ID of the stream to check\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createAlertReceiver\"\u003e\n### createAlertReceiver(parameters, path[, callback])\n\nAdd an alert receiver\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __type__: {String} Type: users or emails\n    * __entity__: {String} Name/ID of user or email address to add as alert receiver\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeAlertReceiver\"\u003e\n### removeAlertReceiver(parameters, path[, callback])\n\nRemove an alert receiver\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __type__: {String} Type: users or emails\n    * __entity__: {String} Name/ID of user or email address to remove from alert receivers\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"testAlertSendDummy\"\u003e\n### testAlertSendDummy(parameters, path[, callback])\n\nSend a test mail for a given stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String} The stream id this new alert condition belongs to\n  * _callback_: {Function} Optional. Callback function\n\n## Counts: Message counts\n\n\u003ca name=\"getCountTotal\"\u003e\n### getCountTotal([callback])\n\nTotal number of messages in all your indices\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## Dashboards: Manage dashboards\n\n\u003ca name=\"createDashboard\"\u003e\n### createDashboard(parameters[, callback])\n\nCreate a dashboard\n\n__Arguments__:\n  * __parameters__: {Object} {CreateDashboardRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getDashboards\"\u003e\n### getDashboards([callback])\n\nGet a list of all dashboards and all configurations of their widgets\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getDashboard\"\u003e\n### getDashboard(parameters, path[, callback])\n\nGet a single dashboards and all configurations of its widgets\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateDashboard\"\u003e\n### updateDashboard(parameters, path[, callback])\n\nUpdate the settings of a dashboard\n\n__Arguments__:\n  * __parameters__: {Object} {UpdateDashboardRequest}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeDashboard\"\u003e\n### removeDashboard(parameters, path[, callback])\n\nDelete a dashboard and all its widgets\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateDashboardPositions\"\u003e\n### updateDashboardPositions(parameters, path[, callback])\n\nUpdate/set the positions of dashboard widgets\n\n__Arguments__:\n  * __parameters__: {Object} {WidgetPositionsRequest}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createDashboardWidget\"\u003e\n### createDashboardWidget(parameters, path[, callback])\n\nAdd a widget to a dashboard\n\n__Arguments__:\n  * __parameters__: {Object} {AddWidgetRequest}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateDashboardWidget\"\u003e\n### updateDashboardWidget(parameters, path[, callback])\n\nUpdate a widget\n\n__Arguments__:\n  * __parameters__: {Object} {AddWidgetRequest}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n    * __widgetId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeDashboardWidget\"\u003e\n### removeDashboardWidget(parameters, path[, callback])\n\nDelete a widget\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n    * __widgetId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateDashboardWidgetCacheTime\"\u003e\n### updateDashboardWidgetCacheTime(parameters, path[, callback])\n\nUpdate cache time of a widget\n\n__Arguments__:\n  * __parameters__: {Object} {UpdateWidgetRequest}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n    * __widgetId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateDashboardWidgetDescription\"\u003e\n### updateDashboardWidgetDescription(parameters, path[, callback])\n\nUpdate description of a widget\n\n__Arguments__:\n  * __parameters__: {Object} {UpdateWidgetRequest}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n    * __widgetId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getDashboardWidgetValue\"\u003e\n### getDashboardWidgetValue(parameters, path[, callback])\n\nGet a single widget value\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __dashboardId__: {String}\n    * __widgetId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## Extractors: Extractors of an input\n\n\u003ca name=\"createInputExtractor\"\u003e\n### createInputExtractor(parameters, path[, callback])\n\nAdd an extractor to an input\n\n__Arguments__:\n  * __parameters__: {Object} {CreateExtractorRequest}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getInputExtractors\"\u003e\n### getInputExtractors(parameters, path[, callback])\n\nList all extractors of an input\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateInputExtractorOrder\"\u003e\n### updateInputExtractorOrder(parameters, path[, callback])\n\nUpdate extractor order of an input\n\n__Arguments__:\n  * __parameters__: {Object} {OrderExtractorsRequest}\n  * __path__: {Object}\n    * __inputId__: {String} Persist ID (!) of input\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateInputExtractor\"\u003e\n### updateInputExtractor(parameters, path[, callback])\n\nUpdate an extractor\n\n__Arguments__:\n  * __parameters__: {Object} {CreateExtractorRequest}\n  * __path__: {Object}\n    * __inputId__: {String}\n    * __extractorId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeInputExtractor\"\u003e\n### removeInputExtractor(parameters, path[, callback])\n\nDelete an extractor\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n    * __extractorId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getInputExtractor\"\u003e\n### getInputExtractor(parameters, path[, callback])\n\nGet information of a single extractor of an input\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n    * __extractorId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## Filters: Message blacklist filters\n\n\u003ca name=\"createBlacklistFilter\"\u003e\n### createBlacklistFilter(parameters[, callback])\n\nCreate a blacklist filter\n\nIt can take up to a second until the change is applied\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __filterEntry__: {FilterDescription}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getBlacklistFilters\"\u003e\n### getBlacklistFilters([callback])\n\nGet all blacklist filters\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getBlacklistFilter\"\u003e\n### getBlacklistFilter(parameters, path[, callback])\n\nGet the existing blacklist filter\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __filterId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateBlacklistFilter\"\u003e\n### updateBlacklistFilter(parameters, path[, callback])\n\nUpdate an existing blacklist filter\n\nIt can take up to a second until the change is applied\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __filterEntry__: {FilterDescription}\n  * __path__: {Object}\n    * __filterId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeBlacklistFilter\"\u003e\n### removeBlacklistFilter(parameters, path[, callback])\n\nRemove the existing blacklist filter\n\nIt can take up to a second until the change is applied\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __filterId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## Indexer/Cluster: Indexer cluster information\n\n\u003ca name=\"getClusterHealth\"\u003e\n### getClusterHealth([callback])\n\nGet cluster and shard health overview\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getClusterName\"\u003e\n### getClusterName([callback])\n\nGet the cluster name\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## Indexer/Failures: Indexer failures\n\n\u003ca name=\"getSystemFailures\"\u003e\n### getSystemFailures(parameters[, callback])\n\nGet a list of failed index operations\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __limit__: {Integer} Limit\n    * __offset__: {Integer} Offset\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getFailuresCount\"\u003e\n### getFailuresCount(parameters[, callback])\n\nTotal count of failed index operations since the given date\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __since__: {String} ISO8601 date\n  * _callback_: {Function} Optional. Callback function\n\n## Indexer/Indices: Index information\n\n\u003ca name=\"getIndicesClosed\"\u003e\n### getIndicesClosed([callback])\n\nGet a list of closed indices that can be reopened\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getIndicesReopened\"\u003e\n### getIndicesReopened([callback])\n\nGet a list of reopened indices, which will not be cleaned by retention cleaning\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeIndex\"\u003e\n### removeIndex(parameters, path[, callback])\n\nDelete an index. This will also trigger an index ranges rebuild job\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * _index_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getIndices\"\u003e\n### getIndices(parameters, path[, callback])\n\nGet information of an index and its shards\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * _index_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"closeIndex\"\u003e\n### closeIndex(parameters, path[, callback])\n\nClose an index. This will also trigger an index ranges rebuild job\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * _index_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"reopenIndex\"\u003e\n### reopenIndex(parameters, path[, callback])\n\nReopen a closed index. This will also trigger an index ranges rebuild job\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * _index_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n## Messages: Single messages\n\n\u003ca name=\"analyzeMessage\"\u003e\n### analyzeMessage(parameters, path[, callback])\n\nAnalyze a message string\n\nReturns what tokens/terms a message string (message or full_message) is split to\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __string__: {String} The string to analyze\n  * __path__: {Object}\n    * __index__: {String} The index the message containing the string is stored in\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getMessage\"\u003e\n### getMessage(parameters, path[, callback])\n\nGet a single message\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __index__: {String} The index this message is stored in\n    * __messageId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## Search/Absolute: Message search\n\n\u003ca name=\"searchAbsolute\"\u003e\n### searchAbsolute(parameters[, callback])\n\nMessage search with absolute timerange\n\nSearch 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\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __from__: {String} Timerange start. See description for date format\n    * __to__: {String} Timerange end. See description for date format\n    * _limit_: {Integer} Optional. Maximum number of messages to return\n    * _offset_: {Integer} Optional. Offset\n    * _filter_: {String} Optional. Filter\n    * __fields__: {String} Comma separated list of fields to return\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchAbsoluteFieldHistogram\"\u003e\n### searchAbsoluteFieldHistogram(parameters[, callback])\n\nField value histogram of a query using an absolute timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __field__: {String} Field of whose values to get the histogram of\n    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)\n    * __from__: {String} Timerange start. See search method description for date format\n    * __to__: {String} Timerange end. See search method description for date format\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchAbsoluteHistogram\"\u003e\n### searchAbsoluteHistogram(parameters[, callback])\n\nDatetime histogram of a query using an absolute timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)\n    * __from__: {String} Timerange start. See search method description for date format\n    * __to__: {String} Timerange end. See search method description for date format\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchAbsoluteStats\"\u003e\n### searchAbsoluteStats(parameters[, callback])\n\nField statistics for a query using an absolute timerange\n\nReturns statistics like min/max or standard deviation of numeric fields over the whole query result set\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __field__: {String} Message field of numeric type to return statistics for\n    * __query__: {String} Query (Lucene syntax)\n    * __from__: {String} Timerange start. See search method description for date format\n    * __to__: {String} Timerange end. See search method description for date format\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchAbsoluteTerms\"\u003e\n### searchAbsoluteTerms(parameters[, callback])\n\nMost common field terms of a query using an absolute timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __field__: {String} Message field of to return terms of\n    * __query__: {String} Query (Lucene syntax)\n    * _size_: {Integer} Optional. Maximum number of terms to return\n    * __from__: {String} Timerange start. See search method description for date format\n    * __to__: {String} Timerange end. See search method description for date format\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchAbsoluteTermsStats\"\u003e\n### searchAbsoluteTermsStats(parameters[, callback])\n\nOrdered field terms of a query computed on another field using an absolute timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __key_field__: {String} Message field of to return terms of\n    * __value_field__: {String} Value field used for computation\n    * __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)\n    * __query__: {String} Query (Lucene syntax)\n    * _size_: {Integer} Optional. Maximum number of terms to return\n    * __from__: {String} Timerange start. See search method description for date format\n    * __to__: {String} Timerange end. See search method description for date format\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n## Search/Keyword: Message search\n\n\u003ca name=\"searchKeyword\"\u003e\n### searchKeyword(parameters[, callback])\n\nMessage search with keyword as timerange\n\nSearch for messages in a timerange defined by a keyword like \"yesterday\" or \"2 weeks ago to wednesday\"\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __keyword__: {String} Range keyword\n    * _limit_: {Integer} Optional. Maximum number of messages to return\n    * _offset_: {Integer} Optional. Offset\n    * _filter_: {String} Optional. Filter\n    * _fields_: {String} Optional. Comma separated list of fields to return\n    * _sort_: {String} Optional. Sorting (field:asc / field:desc)\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchKeywordFieldHistogram\"\u003e\n### searchKeywordFieldHistogram(parameters[, callback])\n\nDatetime histogram of a query using keyword timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __field__: {String} Field of whose values to get the histogram of\n    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)\n    * __keyword__: {String} Range keyword\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchKeywordHistogram\"\u003e\n### searchKeywordHistogram(parameters[, callback])\n\nDatetime histogram of a query using keyword timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)\n    * __keyword__: {String} Range keyword\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchKeywordStats\"\u003e\n### searchKeywordStats(parameters[, callback])\n\nField statistics for a query using a keyword timerange\n\nReturns statistics like min/max or standard deviation of numeric fields over the whole query result set\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __field__: {String} Message field of numeric type to return statistics for\n    * __query__: {String} Query (Lucene syntax)\n    * __keyword__: {String} Range keyword\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchKeywordTerms\"\u003e\n### searchKeywordTerms(parameters[, callback])\n\nMost common field terms of a query using a keyword timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __field__: {String} Message field of to return terms of\n    * __query__: {String} Query (Lucene syntax)\n    * _size_: {Integer} Optional. Maximum number of terms to return\n    * __keyword__: {String} Range keyword\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchKeywordTermsStats\"\u003e\n### searchKeywordTermsStats(parameters[, callback])\n\nOrdered field terms of a query computed on another field using a keyword timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __key_field__: {String} Message field of to return terms of\n    * __value_field__: {String} Value field used for computation\n    * __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)\n    * __query__: {String} Query (Lucene syntax)\n    * _size_: {Integer} Optional. Maximum number of terms to return\n    * __keyword__: {String} Keyword timeframe\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n## Search/Relative: Message search\n\n\u003ca name=\"searchRelative\"\u003e\n### searchRelative(parameters[, callback])\n\nMessage search with relative timerange\n\nSearch for messages in a relative timerange, specified as seconds from now. Example: 300 means search from 5 minutes ago to now\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __range__: {Integer} Relative timeframe to search in. See method description\n    * _limit_: {Integer} Optional. Maximum number of messages to return\n    * _offset_: {Integer} Optional. Offset\n    * _filter_: {String} Optional. Filter\n    * __fields__: {String} Comma separated list of fields to return\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchRelativeFieldHistogram\"\u003e\n### searchRelativeFieldHistogram(parameters[, callback])\n\nField value histogram of a query using a relative timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __field__: {String} Field of whose values to get the histogram of\n    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)\n    * __range__: {Integer} Relative timeframe to search in. See search method description\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchRelativeHistogram\"\u003e\n### searchRelativeHistogram(parameters[, callback])\n\nDatetime histogram of a query using a relative timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __query__: {String} Query (Lucene syntax)\n    * __interval__: {String} Histogram interval / bucket size. (year, quarter, month, week, day, hour or minute)\n    * __range__: {Integer} Relative timeframe to search in. See search method description\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchRelativeStats\"\u003e\n### searchRelativeStats(parameters[, callback])\n\nField statistics for a query using a relative timerange\n\nReturns statistics like min/max or standard deviation of numeric fields over the whole query result set\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __field__: {String} Message field of numeric type to return statistics for\n    * __query__: {String} Query (Lucene syntax)\n    * __range__: {Integer} Relative timeframe to search in. See search method description\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchRelativeTerms\"\u003e\n### searchRelativeTerms(parameters[, callback])\n\nMost common field terms of a query using a relative timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __field__: {String} Message field of to return terms of\n    * __query__: {String} Query (Lucene syntax)\n    * _size_: {Integer} Optional. Maximum number of terms to return\n    * __range__: {Integer} Relative timeframe to search in. See search method description\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"searchRelativeTermsStats\"\u003e\n### searchRelativeTermsStats(parameters[, callback])\n\nOrdered field terms of a query computed on another field using a relative timerange\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __key_field__: {String} Message field of to return terms of\n    * __value_field__: {String} Value field used for computation\n    * __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)\n    * __query__: {String} Query (Lucene syntax)\n    * _size_: {Integer} Optional. Maximum number of terms to return\n    * __range__: {Integer} Relative timeframe to search in. See search method description\n    * _filter_: {String} Optional. Filter\n  * _callback_: {Function} Optional. Callback function\n\n## Search/Saved: Saved searches\n\n\u003ca name=\"createSearchSaved\"\u003e\n### createSearchSaved(parameters[, callback])\n\nCreate a new saved search\n\n__Arguments__:\n  * __parameters__: {Object} {CreateSavedSearchRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getSearchSavedAll\"\u003e\n### getSearchSavedAll([callback])\n\nGet a list of all saved searches\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getSearchSaved\"\u003e\n### getSearchSaved(parameters, path[, callback])\n\nGet a single saved search\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __searchId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateSearchSaved\"\u003e\n### updateSearchSaved(parameters, path[, callback])\n\nUpdate a saved search\n\n__Arguments__:\n  * __parameters__: {Object} {CreateSavedSearchRequest}\n  * __path__: {Object}\n    * __searchId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeSearchSaved\"\u003e\n### removeSearchSaved(parameters, path[, callback])\n\nDelete a saved search\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __searchId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## Sources: Listing message sources (e.g. hosts sending logs)\n\n\u003ca name=\"getSources\"\u003e\n### getSources(parameters[, callback])\n\nGet a list of all sources (not more than 5000) that have messages in the current indices. The result is cached for 10 seconds\n\nRange: The parameter is in seconds relative to the current time. 86400 means \"in the last day\", 0 is special and means \"across all indices\"\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __range__: {Integer} Relative timeframe to search in. See method description\n  * _callback_: {Function} Optional. Callback function\n\n## StaticFields: Static fields of an input\n\n\u003ca name=\"createInputStaticField\"\u003e\n### createInputStaticField(parameters, path[, callback])\n\nAdd a static field to an input\n\n__Arguments__:\n  * __parameters__: {Object} {CreateStaticFieldRequest}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeInputStaticField\"\u003e\n### removeInputStaticField(parameters, path[, callback])\n\nRemove static field of an input\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __Key__: {String}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## StreamOutputs: Manage stream outputs for a given stream\n\n\u003ca name=\"createStreamOutput\"\u003e\n### createStreamOutput(parameters, path[, callback])\n\nAssociate outputs with a stream\n\n__Arguments__:\n  * __parameters__: {Object} {AddOutputRequest}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose outputs we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStreamOutputs\"\u003e\n### getStreamOutputs(parameters, path[, callback])\n\nAssociate outputs with a stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose outputs we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStreamOutput\"\u003e\n### getStreamOutput(parameters, path[, callback])\n\nGet specific output of a stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose outputs we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeStreamOutput\"\u003e\n### removeStreamOutput(parameters, path[, callback])\n\nDelete output of a stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose outputs we want\n    * __outputId__: {String} The id of the output that should be deleted\n  * _callback_: {Function} Optional. Callback function\n\n## StreamRules: Manage stream rules\n\n\u003ca name=\"getStreamRules\"\u003e\n### getStreamRules(parameters, path[, callback])\n\nGet a list of all stream rules\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose stream rule we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStreamRule\"\u003e\n### getStreamRule(parameters, path[, callback])\n\nGet a single stream rules\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The id of the stream whose stream rule we want\n    * __streamRuleId__: {String} The stream rule id we are getting\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createStreamRule\"\u003e\n### createStreamRule(parameters, path[, callback])\n\nCreate a stream rule\n\n__Arguments__:\n  * __parameters__: {Object} {CreateStreamRuleRequest}\n  * __path__: {Object}\n    * __streamid__: {String} The stream id this new rule belongs to\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateStreamRule\"\u003e\n### updateStreamRule(parameters, path[, callback])\n\nUpdate a stream rule\n\n__Arguments__:\n  * __parameters__: {Object} {CreateStreamRuleRequest}\n  * __path__: {Object}\n    * __streamid__: {String} The stream id this rule belongs to\n    * __streamRuleId__: {String} The stream rule id we are updating\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeStreamRule\"\u003e\n### removeStreamRule(parameters, path[, callback])\n\nDelete a stream rule\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamid__: {String} The stream id this new rule belongs to\n    * __streamRuleId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## Streams: Manage streams\n\n\u003ca name=\"getStreams\"\u003e\n### getStreams([callback])\n\nGet a list of all streams\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createStream\"\u003e\n### createStream(parameters[, callback])\n\nCreate a stream\n\n__Arguments__:\n  * __parameters__: {Object} {CreateStreamRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStreamsEnabled\"\u003e\n### getStreamsEnabled([callback])\n\nGet a list of all enabled streams\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStreamThroughput\"\u003e\n### getStreamThroughput(parameters, path[, callback])\n\nCurrent throughput of this stream on this node in messages per second\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStreamAllThroughput\"\u003e\n### getStreamAllThroughput([callback])\n\nCurrent throughput of all visible streams on this node in messages per second\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStream\"\u003e\n### getStream(parameters, path[, callback])\n\nGet a single stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateStream\"\u003e\n### updateStream(parameters, path[, callback])\n\nUpdate a stream\n\n__Arguments__:\n  * __parameters__: {Object} {UpdateStreamRequest}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeStream\"\u003e\n### removeStream(parameters, path[, callback])\n\nDelete a stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"cloneStream\"\u003e\n### cloneStream(parameters, path[, callback])\n\nClone a stream\n\n__Arguments__:\n  * __parameters__: {Object} {CloneStreamRequest}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"pauseStream\"\u003e\n### pauseStream(parameters, path[, callback])\n\nPause a stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"resumeStream\"\u003e\n### resumeStream(parameters, path[, callback])\n\nResume a stream\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"testMatchStream\"\u003e\n### testMatchStream(parameters, path[, callback])\n\nTest matching of a stream against a supplied message\n\n__Arguments__:\n  * __parameters__: {Object} {Map}\n  * __path__: {Object}\n    * __streamId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System: System information of this node\n\n\u003ca name=\"getSystem\"\u003e\n### getSystem([callback])\n\nGet system overview\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getJVM\"\u003e\n### getJVM([callback])\n\nGet JVM information\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getThreadDump\"\u003e\n### getThreadDump([callback])\n\nGet a thread dump\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Buffers: Buffer information of this node.\n\n\u003ca name=\"getBuffers\"\u003e\n### getBuffers([callback])\n\nGet current utilization of buffers and caches of this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getBuffersClasses\"\u003e\n### getBuffersClasses([callback])\n\nGet classnames of current buffer implementations\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Bundles: Content packs\n\n\u003ca name=\"createBundle\"\u003e\n### createBundle(parameters[, callback])\n\nUpload a content pack\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __Request__ body {ConfigurationBundle} Content pack\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getBundles\"\u003e\n### getBundles([callback])\n\nList available content packs\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"exportBundles\"\u003e\n### exportBundles(parameters[, callback])\n\nExport entities as a content pack\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __exportBundle__: {ExportBundle} Export content pack\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getBundle\"\u003e\n### getBundle(parameters, path[, callback])\n\nShow content pack\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __bundleId__: {String} Content pack ID\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateBundle\"\u003e\n### updateBundle(parameters, path[, callback])\n\nUpdate content pack\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __Request__ body {ConfigurationBundle} Content pack\n  * __path__: {Object}\n    * __bundleId__: {String} Content pack ID\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeBundle\"\u003e\n### removeBundle(parameters, path[, callback])\n\nDelete content pack\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __bundleId__: {String} Content pack ID\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"applyBundle\"\u003e\n### applyBundle(parameters, path[, callback])\n\nSet up entities described by content pack\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __bundleId__: {String} Content pack ID\n  * _callback_: {Function} Optional. Callback function\n\n## System/Cluster: Node discovery\n\n\u003ca name=\"getNodeThis\"\u003e\n### getNodeThis([callback])\n\nInformation about this node\n\nThis  de itself to get system information\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getNodes\"\u003e\n### getNodes(parameters, path[, callback])\n\nList all active nodes in this cluster\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __nodeId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getNode\"\u003e\n### getNode(parameters, path[, callback])\n\nInformation about a node\n\nThis 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\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __nodeId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/ClusterStats: Cluster stats\n\n\u003ca name=\"getClusterStats\"\u003e\n### getClusterStats([callback])\n\nCluster snformation\n\nThis resource returns information about the Graylog cluster\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getClusterStatsElasticsearch\"\u003e\n### getClusterStatsElasticsearch([callback])\n\nElasticsearch information\n\nThis resource returns information about the Elasticsearch Cluster\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getClusterStatsMongo\"\u003e\n### getClusterStatsMongo([callback])\n\nMongoDB information\n\nThis aut MongoDB\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Collectors: Management of Graylog Collectors\n\n\u003ca name=\"getSystemCollectors\"\u003e\n### getSystemCollectors([callback])\n\nLists all existing collector registrations\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getSystemCollector\"\u003e\n### getSystemCollector(parameters, path[, callback])\n\nReturns at most one collector summary for the specified collector id\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __collectorId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Collectors/Registration: Registration resource for Graylog Collector nodes\n\n\u003ca name=\"changeCollector\"\u003e\n### changeCollector(parameters, path[, callback])\n\nCreate/update an collector registration\n\nThis is a stateless method which upserts a collector registration\n\n__Arguments__:\n  * __parameters__: {Object} {CollectorRegistrationRequest}\n  * __path__: {Object}\n    * __collectorId__: {String} The collector id this collector is registering as\n  * _callback_: {Function} Optional. Callback function\n\n## System/Debug/Events: For debugging local and cluster events.\n\n\u003ca name=\"createDebugEventsCluster\"\u003e\n### createDebugEventsCluster(parameters[, callback])\n\nCreate and send a cluster debug event\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _text_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getDebugEventsCluster\"\u003e\n### getDebugEventsCluster([callback])\n\nShow last received cluster debug event\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createDebugEventsLocal\"\u003e\n### createDebugEventsLocal(parameters[, callback])\n\nCreate and send a local debug event\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _text_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getDebugEventsLocal\"\u003e\n### getDebugEventsLocal([callback])\n\nShow last received local debug event\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Deflector: Index deflector management\n\n\u003ca name=\"getDeflector\"\u003e\n### getDeflector([callback])\n\nGet current deflector status\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getDeflectorConfig\"\u003e\n### getDeflectorConfig([callback])\n\nGet deflector configuration. Only available on master nodes\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"nextDeflectorCycle\"\u003e\n### nextDeflectorCycle([callback])\n\nCycle deflector to new/next index\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Fields: Get list of message fields that exist.\n\n\u003ca name=\"getFields\"\u003e\n### getFields(parameters[, callback])\n\nGet list of message fields that exist\n\nThis operation is comparably fast because it reads directly from the indexer mapping\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _limit_: {Integer} Optional. Maximum number of fields to return. Set to 0 for all fields\n  * _callback_: {Function} Optional. Callback function\n\n## System/Grok: Manage grok patterns\n\n\u003ca name=\"getGroks\"\u003e\n### getGroks([callback])\n\nGet all existing grok patterns\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getGrok\"\u003e\n### getGrok(parameters, path[, callback])\n\nGet the existing grok pattern\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __patternId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createGrok\"\u003e\n### createGrok(parameters[, callback])\n\nAdd a new named pattern\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __pattern__: {GrokPatternSummary}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createGroks\"\u003e\n### createGroks(parameters[, callback])\n\nUpdate an existing pattern\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __patterns__: {Array}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateGrok\"\u003e\n### updateGrok(parameters, path[, callback])\n\nUpdate an existing pattern\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __pattern__: {GrokPatternSummary}\n  * __path__: {Object}\n    * __patternId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeGrok\"\u003e\n### removeGrok([callback])\n\nRemove an existing pattern by id\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/IndexRanges: Index timeranges\n\n\u003ca name=\"getIndicesRanges\"\u003e\n### getIndicesRanges([callback])\n\nGet a list of all index ranges\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"rebuildIndicesRanges\"\u003e\n### rebuildIndicesRanges([callback])\n\nRebuild/sync index range information\n\nThis as in what timeranges. It atomically overwrites already existing meta information\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Inputs: Message inputs of this node\n\n\u003ca name=\"createInput\"\u003e\n### createInput(parameters[, callback])\n\nLaunch input on this node\n\n__Arguments__:\n  * __parameters__: {Object} {InputLaunchRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getInput\"\u003e\n### getInput(null, path[, callback])\n\nGet information of a single input on this node\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getInputs\"\u003e\n### getInputs([callback])\n\nGet all inputs of this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateInput\"\u003e\n### updateInput(parameters, path[, callback])\n\nUpdate input on this node\n\n__Arguments__:\n  * __parameters__: {Object} {InputLaunchRequest}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeInput\"\u003e\n### removeInput(parameters, path[, callback])\n\nTerminate input on this node\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"launchInput\"\u003e\n### launchInput(parameters, path[, callback])\n\nLaunch existing input on this node\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"restartInput\"\u003e\n### restartInput(parameters, path[, callback])\n\nRestart existing input on this node\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"stopInput\"\u003e\n### stopInput(parameters, path[, callback])\n\nStop existing input on this node\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Inputs/Types: Message input types of this node\n\n\u003ca name=\"getInputsType\"\u003e\n### getInputsType(parameters, path[, callback])\n\nGet information about a single input type\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __inputType__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getInputsTypes\"\u003e\n### getInputsTypes([callback])\n\nGet all available input types of this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Jobs: System Jobs\n\n\u003ca name=\"createJob\"\u003e\n### createJob(parameters[, callback])\n\nTrigger new job\n\n__Arguments__:\n  * __parameters__: {Object} {TriggerRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getJobs\"\u003e\n### getJobs([callback])\n\nList currently running jobs\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getJob\"\u003e\n### getJob(parameters, path[, callback])\n\nGet information of a specific currently running job\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __jobId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Journal: Message journal information of this node.\n\n\u003ca name=\"getJournal\"\u003e\n### getJournal([callback])\n\nGet current state of the journal on this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/LDAP: LDAP settings\n\n\u003ca name=\"getLDAPSettings\"\u003e\n### getLDAPSettings([callback])\n\nGet the LDAP configuration if it is configured\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateLDAPSettings\"\u003e\n### updateLDAPSettings(parameters[, callback])\n\nUpdate the LDAP configuration\n\n__Arguments__:\n  * __parameters__: {Object} {LdapSettingsRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeLDAPSettings\"\u003e\n### removeLDAPSettings([callback])\n\nRemove the LDAP configuration\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"testLDAPSettings\"\u003e\n### testLDAPSettings(parameters[, callback])\n\nTest LDAP Configuration\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __Configuration__ to test {LdapTestConfigRequest}\n  * _callback_: {Function} Optional. Callback function\n\n## System/LoadBalancers: Status propagation for load balancers\n\n\u003ca name=\"getLoadBalancerStatus\"\u003e\n### getLoadBalancerStatus([callback])\n\nGet status of this graylog2-server node for load balancers. Returns either ALIVE with HTTP 200 or DEAD with HTTP 503\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateLoadBalancerStatusOverride\"\u003e\n### updateLoadBalancerStatusOverride(parameters, path[, callback])\n\nOverride load balancer status of this graylog2-server node. Next lifecycle change will override it again to its default. Set to ALIVE or DEAD\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * _status_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n## System/Loggers: Internal Graylog loggers\n\n\u003ca name=\"getLoggers\"\u003e\n### getLoggers([callback])\n\nList all loggers and their current levels\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getLoggersSubsystems\"\u003e\n### getLoggersSubsystems([callback])\n\nList all logger subsystems and their current levels\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"setLoggersSubsystemsLevel\"\u003e\n### setLoggersSubsystemsLevel(parameters, path[, callback])\n\nSet the loglevel of a whole subsystem\n\nProvided level is falling back to DEBUG if it does not exist\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __subsystem__: {String}\n    * __level__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"setLoggersLevel\"\u003e\n### setLoggersLevel(parameters, path[, callback])\n\nSet the loglevel of a single logger\n\nProvided level is falling back to DEBUG if it does not exist\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __loggerName__: {String}\n    * __level__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Messages: Internal Graylog messages\n\n\u003ca name=\"getSystemMessages\"\u003e\n### getSystemMessages(parameters[, callback])\n\nGet internal Graylog system messages\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _page_: {Integer} Optional. Page\n  * _callback_: {Function} Optional. Callback function\n\n## System/Metrics: Internal Graylog2 metrics\n\n\u003ca name=\"getMetric\"\u003e\n### getMetric(parameters, path[, callback])\n\nGet a single metric\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __metricName__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getMetrics\"\u003e\n### getMetrics([callback])\n\nGet all metrics\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getMetricsMultiple\"\u003e\n### getMetricsMultiple(parameters[, callback])\n\nGet the values of multiple metrics at once\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __Requested__ metrics {MetricsReadRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getMetricsNames\"\u003e\n### getMetricsNames([callback])\n\nGet all metrics keys/names\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getMetricsNamespace\"\u003e\n### getMetricsNamespace(parameters, path[, callback])\n\nGet all metrics of a namespace\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __namespace__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Metrics/History: Get history of metrics\n\n\u003ca name=\"getMetricsHistory\"\u003e\n### getMetricsHistory(parameters, path[, callback])\n\nGet history of a single metric\nThe maximum retention time is currently only 5 minutes\n\n__Arguments__:\n  * __parameters__: {Object}\n    * _after_: {Long} Optional. Only values for after this UTC timestamp (1970 epoch)\n  * __path__: {Object}\n    * __metricName__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Notifications: Notifications generated by the system\n\n\u003ca name=\"getNotifications\"\u003e\n### getNotifications([callback])\n\nGet all active notifications\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeNotification\"\u003e\n### removeNotification(parameters, path[, callback])\n\nDelete a notification\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * _notificationType_: {String} Optional.\n  * _callback_: {Function} Optional. Callback function\n\n## System/Outputs: Manage outputs\n\n\u003ca name=\"getOutput\"\u003e\n### getOutput(parameters, path[, callback])\n\nGet specific output\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __outputId__: {String} The id of the output we want\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getOutputs\"\u003e\n### getOutputs([callback])\n\nGet a list of all outputs\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createOutput\"\u003e\n### createOutput(parameters[, callback])\n\nCreate an output\n\n__Arguments__:\n  * __parameters__: {Object} {CreateOutputRequest}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getOutputsAvailable\"\u003e\n### getOutputsAvailable([callback])\n\nGet all available output modules\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateOutput\"\u003e\n### updateOutput(parameters, path[, callback])\n\nUpdate output\n\n__Arguments__:\n  * __parameters__: {Object} {Map}\n  * __path__: {Object}\n    * __outputId__: {String} The id of the output that should be deleted\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeOutput\"\u003e\n### removeOutput(parameters, path[, callback])\n\nDelete output\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __outputId__: {String} The id of the output that should be deleted\n  * _callback_: {Function} Optional. Callback function\n\n## System/Permissions: Retrieval of system permissions\n\n\u003ca name=\"getPermissions\"\u003e\n### getPermissions([callback])\n\nGet all available user permissions\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getPermissionsReader\"\u003e\n### getPermissionsReader(parameters, path[, callback])\n\nGet the initial permissions assigned to a reader account\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Plugin: Plugin information\n\n\u003ca name=\"getSystemPlugins\"\u003e\n### getSystemPlugins([callback])\n\nList all installed plugins on this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Processing: System processing status control\n\n\u003ca name=\"pauseSystemProcessing\"\u003e\n### pauseSystemProcessing([callback])\n\nPauses message processing\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"resumeSystemProcessing\"\u003e\n### resumeSystemProcessing([callback])\n\nResume message processing\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Radios: Management of graylog2-radio nodes\n\n\u003ca name=\"getRadio\"\u003e\n### getRadio(parameters, path[, callback])\n\nInformation about a radio\n\nThis 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\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __radioId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getRadios\"\u003e\n### getRadios([callback])\n\nList all active radios in this cluster\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createRadioInput\"\u003e\n### createRadioInput(parameters, path[, callback])\n\nRegister input of a radio\n\nRadio inputs register their own inputs here for persistence after they successfully launched it\n\n__Arguments__:\n  * __parameters__: {Object} {RegisterInputRequest}\n  * __path__: {Object}\n    * __radioId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getRadioInputs\"\u003e\n### getRadioInputs(parameters, path[, callback])\n\nPersisted inputs of a radio\n\nThis 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\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __radioId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeRadioInput\"\u003e\n### removeRadioInput(parameters, path[, callback])\n\nUnregister input of a radio\n\nRadios unregister their inputs when they are stopped/terminated on the radio\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __radioId__: {String}\n    * __inputId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"pingRadio\"\u003e\n### pingRadio(parameters, path[, callback])\n\nPing - Accepts pings of graylog2-radio nodes\n\nEvery graylog2-radio node is regularly pinging to announce that it is active\n\n__Arguments__:\n  * __parameters__: {Object} {PingRequest}\n  * __path__: {Object}\n    * __radioId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/ServiceManager: ServiceManager Status\n\n\u003ca name=\"getServiceManager\"\u003e\n### getServiceManager([callback])\n\nList current status of ServiceManager\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Sessions: Login for interactive user sessions\n\n\u003ca name=\"createSession\"\u003e\n### createSession(parameters[, callback])\n\nThis request creates a new session for a user or reactivates an existing session: the equivalent of logging in\n\n__Arguments__:\n  * __parameters__: {Object}\n    * __Login__ request {SessionCreateRequest} Username and credentials\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeSession\"\u003e\n### removeSession(parameters, path[, callback])\n\nTerminate an existing session\n\nDestroys the session with the given ID: the equivalent of logging out\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __sessionId__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n## System/Shutdown: Shutdown this node gracefully\n\n\u003ca name=\"shutdownNode\"\u003e\n### shutdownNode([callback])\n\nShutdown this node gracefully\n\nAttempts  at no new messages are accepted\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Stats: Node system stats\n\n\u003ca name=\"getStats\"\u003e\n### getStats([callback])\n\nSystem o this node\n\nThis resource returns information about the system this node is running on\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStatsFs\"\u003e\n### getStatsFs([callback])\n\nFilesystem o this node\n\nThis resource returns information about the filesystems of this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStatsJvm\"\u003e\n### getStatsJvm([callback])\n\nJVM information o this node\n\nThis resource returns information about the Java Virtual Machine of this node\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStatsNetwork\"\u003e\n### getStatsNetwork([callback])\n\nNetworking o this node\n\nThis resource returns information about the networking system this node is running with\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStatsOs\"\u003e\n### getStatsOs([callback])\n\nOS information o this node\n\nThis resource returns information about the operating system this node is running on\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getStatsProcess\"\u003e\n### getStatsProcess([callback])\n\nProcess information about this node\n\nThis irunning as\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## System/Throughput: Message throughput of this node\n\n\u003ca name=\"getThroughput\"\u003e\n### getThroughput([callback])\n\nCurrent throughput of this node in messages per second\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n## Users: User accounts\n\n\u003ca name=\"getUser\"\u003e\n### getUser(parameters, path[, callback])\n\nGet user details\n\nThe user's permissions are only included if a user asks for his own account or for users with the necessary permissions to edit permissions\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String} The username to return information for\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getUsers\"\u003e\n### getUsers([callback])\n\nLurs\n\nThe permissions assigned to the users are always included\n\n__Arguments__:\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createUser\"\u003e\n### createUser(parameters[, callback])\n\nCreate a new user account\n\n__Arguments__:\n  * __parameters__: {Object} {CreateUserRequest} Must contain username, full_name, email, password and a list of permissionsteUserRequest'\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateUser\"\u003e\n### updateUser(parameters, path[, callback])\n\nModify user details\n\n__Arguments__:\n  * __parameters__: {Object} {ChangeUserRequest} Updated user information\n  * __path__: {Object}\n    * __username__: {String} The name of the user to modify\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeUser\"\u003e\n### removeUser(parameters, path[, callback])\n\nRemoves a user account\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String} The name of the user to delete\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateUserPassword\"\u003e\n### updateUserPassword(parameters, path[, callback])\n\nUpdate the password for a user\n\n__Arguments__:\n  * __parameters__: {Object} {ChangePasswordRequest} The old and new passwords\n  * __path__: {Object}\n    * __username__: {String} The name of the user whose password to change\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateUserPermissions\"\u003e\n### updateUserPermissions(parameters, path[, callback])\n\nUpdate a user's permission set\n\n__Arguments__:\n  * __parameters__: {Object} {PermissionEditRequest} The list of permissions to assign to the user\n  * __path__: {Object}\n    * __username__: {String} The name of the user to modify\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeUserPermissions\"\u003e\n### removeUserPermissions(parameters, path[, callback])\n\nRevoke all permissions for a user without deleting the account\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String} The name of the user to modify\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"updateUserPreferences\"\u003e\n### updateUserPreferences(parameters, path[, callback])\n\nUpdate a user's preferences set\n\n__Arguments__:\n  * __parameters__: {Object} {UpdateUserPreferences} The map of preferences to assign to the user\n  * __path__: {Object}\n    * __username__: {String} The name of the user to modify\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"getUserTokens\"\u003e\n### getUserTokens(parameters, path[, callback])\n\nRetrieves the list of access tokens for a user\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String}\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"createUserToken\"\u003e\n### createUserToken(parameters, path[, callback])\n\nGenerates a new access token for a user\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String}\n    * __name__: {String} Descriptive name for this token (e.g. \"cronjob\")\n  * _callback_: {Function} Optional. Callback function\n\n\u003ca name=\"removeUserToken\"\u003e\n### removeUserToken(parameters, path[, callback])\n\nRemoves a token for a user\n\n__Arguments__:\n  * __parameters__: {null}\n  * __path__: {Object}\n    * __username__: {String}\n    * __access__: token {String}\n  * _callback_: {Function} Optional. Callback function\n\n## License\n\nThe MIT License (MIT)\n\nCopyright (c) 2015 Andrii Kolomiichenko (bboywilld@gmail.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkolomiichenko%2Fgraylog-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkolomiichenko%2Fgraylog-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkolomiichenko%2Fgraylog-api/lists"}