Repos

Manage repositories.

Usage:

shell
humioctl repos [command]

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

Table: Repos commands

ParameterDescription
Create Create a repository.
Delete Delete a repository.
List List repositories.
Show Show details about a repository.
Update Update the settings of a repository.

Table: Local flags

ParameterDescription
-h, --help Help for repos

Table: Global flags

ParameterDescription
-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.

Create

Create a repository.

Usage:

shell
humioctl repos create <repo> [flags]

Table: Local flags

ParameterDescription
-h, --help Help for create

Hide global flags

Show global flags

Delete

Delete a repository. You must provide a reason for the deletion.

Usage:

shell
humioctl repos delete [flags] <repo> "<reason>"

Table: Local flags

ParameterDescription
--allow-data-deletion Allow deleting a repository that contains data.
-h, --help Help for delete

Hide global flags

Show global flags

List

List repositories.

Usage:

shell
humioctl repos list [flags]

Table: Local flags

ParameterDescription
-h, --help Help for list
-r, --reverse Reverse the sorting order. Default: true.
-s, --size Sort by size instead of name.

Hide global flags

Show global flags

Show

Show details about a repository.

Usage:

shell
humioctl repos show <repo> [flags]

Table: Local flags

ParameterDescription
-h, --help Help for show

Hide global flags

Show global flags

Update

Update the settings of a repository.

Usage:

shell
humioctl repos update [flags] <repo>

Table: Local flags

ParameterDescription
--allow-data-deletion Allow changing retention settings for a non-empty repository.
--description string The description of the repository.
--disable-automatic-search Disable automatic search for the repository.
--disable-s3-archiving Disable S3 archiving.
--enable-automatic-search Enable automatic search for the repository.
--enable-s3-archiving Enable S3 archiving.
-h, --help Help for update
--ingest-size-based-retention float The ingest size-based retention setting for the repository.
--retention-time float The retention time in days for the repository.
--s3-archiving-bucket string The name of the bucket to use for S3 archiving.
--s3-archiving-format string The S3 archiving format. Possible values: RAW or NDJSON.
--s3-archiving-region string The S3 region to use for S3 archiving.
--storage-size-based-retention float The storage size-based retention setting for the repository.

Hide global flags

Show global flags