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.
For more detail you can look Graylog REST API browser: 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.
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;
`

* 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

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

$3

AlarmCallbacks: Manage stream alarm callbacks

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

Total number of messages in all your indices

__Arguments__:
* _callback_: {Function} Optional. Callback function

Dashboards: Manage dashboards

$3

Create a dashboard

__Arguments__:
* __parameters__: {Object} {CreateDashboardRequest}
* _callback_: {Function} Optional. Callback function

$3

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

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get a single dashboards and all configurations of its widgets

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __dashboardId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update the settings of a dashboard

__Arguments__:
* __parameters__: {Object} {UpdateDashboardRequest}
* __path__: {Object}
* __dashboardId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Delete a dashboard and all its widgets

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __dashboardId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update/set the positions of dashboard widgets

__Arguments__:
* __parameters__: {Object} {WidgetPositionsRequest}
* __path__: {Object}
* __dashboardId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Add a widget to a dashboard

__Arguments__:
* __parameters__: {Object} {AddWidgetRequest}
* __path__: {Object}
* __dashboardId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update a widget

__Arguments__:
* __parameters__: {Object} {AddWidgetRequest}
* __path__: {Object}
* __dashboardId__: {String}
* __widgetId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Delete a widget

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __dashboardId__: {String}
* __widgetId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update cache time of a widget

__Arguments__:
* __parameters__: {Object} {UpdateWidgetRequest}
* __path__: {Object}
* __dashboardId__: {String}
* __widgetId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update description of a widget

__Arguments__:
* __parameters__: {Object} {UpdateWidgetRequest}
* __path__: {Object}
* __dashboardId__: {String}
* __widgetId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Get a single widget value

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __dashboardId__: {String}
* __widgetId__: {String}
* _callback_: {Function} Optional. Callback function

Extractors: Extractors of an input

$3

Add an extractor to an input

__Arguments__:
* __parameters__: {Object} {CreateExtractorRequest}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

List all extractors of an input

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update extractor order of an input

__Arguments__:
* __parameters__: {Object} {OrderExtractorsRequest}
* __path__: {Object}
* __inputId__: {String} Persist ID (!) of input
* _callback_: {Function} Optional. Callback function

$3

Update an extractor

__Arguments__:
* __parameters__: {Object} {CreateExtractorRequest}
* __path__: {Object}
* __inputId__: {String}
* __extractorId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Delete an extractor

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputId__: {String}
* __extractorId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

$3

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

$3

Get all blacklist filters

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get the existing blacklist filter

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __filterId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

$3

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

$3

Get cluster and shard health overview

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get the cluster name

__Arguments__:
* _callback_: {Function} Optional. Callback function

Indexer/Failures: Indexer failures

$3

Get a list of failed index operations

__Arguments__:
* __parameters__: {Object}
* __limit__: {Integer} Limit
* __offset__: {Integer} Offset
* _callback_: {Function} Optional. Callback function

$3

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

$3

Get a list of closed indices that can be reopened

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

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

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

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

$3

Get information of an index and its shards

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* _index_: {String} Optional.
* _callback_: {Function} Optional. Callback function

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

Create a new saved search

__Arguments__:
* __parameters__: {Object} {CreateSavedSearchRequest}
* _callback_: {Function} Optional. Callback function

$3

Get a list of all saved searches

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get a single saved search

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __searchId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update a saved search

__Arguments__:
* __parameters__: {Object} {CreateSavedSearchRequest}
* __path__: {Object}
* __searchId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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)

$3

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

$3

Add a static field to an input

__Arguments__:
* __parameters__: {Object} {CreateStaticFieldRequest}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

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

$3

Get a list of all streams

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Create a stream

__Arguments__:
* __parameters__: {Object} {CreateStreamRequest}
* _callback_: {Function} Optional. Callback function

$3

Get a list of all enabled streams

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

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

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get a single stream

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Update a stream

__Arguments__:
* __parameters__: {Object} {UpdateStreamRequest}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Delete a stream

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Clone a stream

__Arguments__:
* __parameters__: {Object} {CloneStreamRequest}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Pause a stream

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Resume a stream

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __streamId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

$3

Get system overview

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get JVM information

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get a thread dump

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/Buffers: Buffer information of this node.

$3

Get current utilization of buffers and caches of this node

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get classnames of current buffer implementations

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/Bundles: Content packs

$3

Upload a content pack

__Arguments__:
* __parameters__: {Object}
* __Request__ body {ConfigurationBundle} Content pack
* _callback_: {Function} Optional. Callback function

$3

List available content packs

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Export entities as a content pack

__Arguments__:
* __parameters__: {Object}
* __exportBundle__: {ExportBundle} Export content pack
* _callback_: {Function} Optional. Callback function

$3

Show content pack

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __bundleId__: {String} Content pack ID
* _callback_: {Function} Optional. Callback function

$3

Update content pack

__Arguments__:
* __parameters__: {Object}
* __Request__ body {ConfigurationBundle} Content pack
* __path__: {Object}
* __bundleId__: {String} Content pack ID
* _callback_: {Function} Optional. Callback function

$3

Delete content pack

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __bundleId__: {String} Content pack ID
* _callback_: {Function} Optional. Callback function

$3

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

$3

Information about this node

This de itself to get system information

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

List all active nodes in this cluster

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __nodeId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

$3

Cluster snformation

This resource returns information about the Graylog cluster

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Elasticsearch information

This resource returns information about the Elasticsearch Cluster

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

MongoDB information

This aut MongoDB

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/Collectors: Management of Graylog Collectors

$3

Lists all existing collector registrations

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

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

$3

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.

$3

Create and send a cluster debug event

__Arguments__:
* __parameters__: {Object}
* _text_: {String} Optional.
* _callback_: {Function} Optional. Callback function

$3

Show last received cluster debug event

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Create and send a local debug event

__Arguments__:
* __parameters__: {Object}
* _text_: {String} Optional.
* _callback_: {Function} Optional. Callback function

$3

Show last received local debug event

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/Deflector: Index deflector management

$3

Get current deflector status

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get deflector configuration. Only available on master nodes

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Cycle deflector to new/next index

__Arguments__:
* _callback_: {Function} Optional. Callback function

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

$3

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

$3

Get all existing grok patterns

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Get the existing grok pattern

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __patternId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Add a new named pattern

__Arguments__:
* __parameters__: {Object}
* __pattern__: {GrokPatternSummary}
* _callback_: {Function} Optional. Callback function

$3

Update an existing pattern

__Arguments__:
* __parameters__: {Object}
* __patterns__: {Array}
* _callback_: {Function} Optional. Callback function

$3

Update an existing pattern

__Arguments__:
* __parameters__: {Object}
* __pattern__: {GrokPatternSummary}
* __path__: {Object}
* __patternId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Remove an existing pattern by id

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/IndexRanges: Index timeranges

$3

Get a list of all index ranges

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

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

$3

Launch input on this node

__Arguments__:
* __parameters__: {Object} {InputLaunchRequest}
* _callback_: {Function} Optional. Callback function

$3

Get information of a single input on this node

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Get all inputs of this node

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Update input on this node

__Arguments__:
* __parameters__: {Object} {InputLaunchRequest}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Terminate input on this node

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Launch existing input on this node

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

Restart existing input on this node

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputId__: {String}
* _callback_: {Function} Optional. Callback function

$3

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

$3

Get information about a single input type

__Arguments__:
* __parameters__: {null}
* __path__: {Object}
* __inputType__: {String}
* _callback_: {Function} Optional. Callback function

$3

Get all available input types of this node

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/Jobs: System Jobs

$3

Trigger new job

__Arguments__:
* __parameters__: {Object} {TriggerRequest}
* _callback_: {Function} Optional. Callback function

$3

List currently running jobs

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

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.

$3

Get current state of the journal on this node

__Arguments__:
* _callback_: {Function} Optional. Callback function

System/LDAP: LDAP settings

$3

Get the LDAP configuration if it is configured

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Update the LDAP configuration

__Arguments__:
* __parameters__: {Object} {LdapSettingsRequest}
* _callback_: {Function} Optional. Callback function

$3

Remove the LDAP configuration

__Arguments__:
* _callback_: {Function} Optional. Callback function

$3

Test LDAP Configuration

__Arguments__:
* __parameters__: {Object}
* __Configuration__ to test {LdapTestConfigRequest}
* _callback_: {Function} Optional. Callback function

System/LoadBalancers: Status propagation for load balancers

$3

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

$3