Ingest tokens
Manage ingest tokens. Ingest tokens, unlike the more general API tokens, can only be used for ingestion of data.
You can assign a parser to an ingest token to configure how LogScale parses incoming data without changing the sender or client configuration.
Usage:
shell
humioctl ingest-tokens [command]Use humioctl ingest-tokens [command] --help for more information about a command.
Table: Ingest token commands
| Parameter | Description |
|---|---|
Add | Add an ingest token to a repository. |
List | List all ingest tokens in a repository. |
Remove | Remove an ingest token. |
Show | Show details about an ingest token in a repository. |
Update | Update an ingest token in a repository. |
Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for ingest-tokens |
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. |
Add
Add a new ingest token <token-name> to repository <repo>. Use
--parser to assign a parser to the token so that
all data sent with it uses the assigned parser at ingest time.
Usage:
shell
humioctl ingest-tokens add [flags] <repo> <token-name>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for add |
-p, --parser string | Assigns a parser to the ingest token. All data sent with this token uses the assigned parser at ingest time. |
Hide 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 ingest tokens in a repository.
Usage:
shell
humioctl ingest-tokens list [flags] <repo>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for list |
Hide 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 ingest token <token-name> from repository <repo>.
Usage:
shell
humioctl ingest-tokens remove [flags] <repo> <token-name>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for remove |
Hide 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 an ingest token in a repository.
Usage:
shell
humioctl ingest-tokens show [flags] <repo> <token-name>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for show |
Hide 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. |
Update
Update the parser of ingest token <token> in repository
<repository>. If --parser is omitted, the
token is not associated with a parser.
Usage:
shell
humioctl ingest-tokens update [flags] <repository> <token>Table: Local flags
| Parameter | Description |
|---|---|
-h, --help | Help for update |
-p, --parser string | Assigns a parser to the ingest token. All data sent with this token uses the assigned parser at ingest time. If omitted, the token is not associated with a parser. |
Hide 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. |