Filter alerts

Manage filter alerts.

Usage:

shell

humioctl filter-alerts [command]

Use humioctl filter-alerts [command] --help for more information about a command.

Table: Filter alert commands

Parameter	Description
`Export`	Export a filter alert <filter-alert> in <view> to a file.
`Export all`	Export all filter alerts.
`Install`	Install a filter alert in a view.
`List`	List all filter alerts in a view.
`Remove`	Remove a filter alert.
`Show`	Show details about a filter alert in a view.

Table: Local flags

Parameter	Description
`-h, --help`	Help for filter-alerts

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Export

Export a filter alert <filter-alert> in <view> to a file.

Usage:

shell

humioctl filter-alerts export [flags] <view> <filter-alert>

Table: Local flags

Parameter	Description
`-h, --help`	Help for export
`-o, --output string`	The file path where the filter alert should be written. Defaults to `./<filter-alert-name>.yaml`

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Export all

Export all filter alerts to YAML files with naming <sanitized-filter-alert-name>.yaml. All non-alphanumeric characters will be replaced with underscore.

Usage:

shell

humioctl filter-alerts export-all <view> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for export-all
`-d, --outputDirectory string`	The file path where the filter alerts should be written. Defaults to the current directory.

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Install

Install a filter alert from a URL or from a local file, for example:

shell

humioctl filter-alerts install viewName --url=https://example.com/acme/filter-alert.yaml
humioctl filter-alerts install viewName --file=./filter-alert.yaml

Usage:

shell

humioctl filter-alerts install [flags] <view>

Table: Local flags

Parameter	Description
`--file string`	The local file path to the filter alert to install.
`-h, --help`	Help for install
`-n, --name name`	Install the filter alert under a specific name, ignoring the name attribute in the filter alert file.
`--url string`	A URL to fetch the filter alert file from.

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

List

List all filter alerts in a view.

Usage:

shell

humioctl filter-alerts list <view> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for list

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Remove

Remove the filter alert <name> from <view>.

Usage:

shell

humioctl filter-alerts remove <view> <name> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for remove

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Show

Show details about a filter alert in a view.

Usage:

shell

humioctl filter-alerts show <view> <name> [flags]

Table: Local flags

Parameter	Description
`-h, --help`	Help for show

Hide global flags

Show global flags

Table: Global flags

Parameter	Description
`-a,--address string`	The HTTP address of the Humio cluster. Overrides the value in your config file.
`--ca-certificate-file string`	File path to a file containing the CA certificate in PEM format. Overrides the value in your config file.
`-c, --config string`	Config file (default is `$HOME/.humio/config.yaml`)
`--format string`	Change output format of commands, if supported. Valid formats: json
`--insecure`	By default, all encrypted connections will verify that the hostname in the TLS certificate matches the name from the URL. Set this to true to ignore hostname validation.
`-u, --profile string`	Name of the config profile to use
`--proxy-organization string`	Commands are executed in the specified organization.
`-t, --token string`	The API token to use when talking to Humio. Overrides the value in your config file.
`--token-file string`	File path to a file containing the API token. Overrides the value in your config file and the value of --token.
`--unix-socket-proxy string`	Path to a unix socket to use as an HTTP proxy.

Versions of this Page

Command line tools and scripts

Command-Line Interface (humioctl)

Filter alerts

Export

Export all

Install

List

Remove

Show

Enter search term