kosli create api-key - Kosli Documentation

Synopsis

kosli create api-key [flags]

Create an API key for a service account. The key value is only returned once, at creation time, so make sure to store it securely.

Flag	Description
`-d`, `--description` string	A description for the API key.
`-D`, `--dry-run`	[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors.
`-e`, `--expires-at` string	[optional] When the API key expires. Accepts an epoch timestamp or a date like ‘2026-06-04’, ‘2026-06-04 15:04:05’, or an RFC3339 timestamp. Defaults to no expiry.
`-h`, `--help`	help for api-key
`-o`, `--output` string	[defaulted] The format of the output. Valid formats are: [table, json]. (default “table”)
`-s`, `--service-account` string	The name of the service account whose API keys are managed.

Flag	Description
`-a`, `--api-token` string	The Kosli API token.
`-c`, `--config-file` string	[optional] The Kosli config file path. (default “kosli”)
`--debug`	[optional] Print debug logs to stdout.
`-H`, `--host` string	[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
`--http-proxy` string	[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`
`-r`, `--max-api-retries` int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
`--org` string	The Kosli organization.
`-q`, `--quiet`	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

create an API key for a service account

kosli create api-key 
	--service-account yourServiceAccountName 
	--description "key for CI" 

create an API key that expires on a given date

kosli create api-key 
	--service-account yourServiceAccountName 
	--description "key for CI" 
	--expires-at 2026-12-31 

Last modified on June 9, 2026

⌘I