ybm api-key

Manage API keys

Use the api-key resource to create and manage YugabyteDB Aeon account API keys.

Syntax

Usage: ybm api-key [command] [flags]

Create an API key in YugabyteDB Aeon:

ybm api-key create \
    --name developer \
    --duration 6 --unit Months \
    --description "Developer API key" \
    --role-name Developer

List API keys in YugabyteDB Aeon:

ybm api-key list

Create an API key.

Flag	Description
--name	Required. Name for the API key.
--duration	Required. The duration for which the API Key will be valid. 0 denotes that the key will never expire.
--unit	Required. The time unit for the duration for which the API Key will be valid. `Hours`, `Days`, or `Months`.
--description	Description for the API key.
--role-name	The name of the role to assign to the API Key. If not provided, the Admin role is assigned.
--network-allow-lists	To restrict use of the API key to specific IP addresses, provide comma-separated names of network allow lists.

List the API keys in your YugabyteDB Aeon account.

Flag	Description
--name	Return only API keys with the specified name.
--status	Return only API keys with the specified status. `ACTIVE`, `EXPIRED`, or `REVOKED`.

Revoke a specified API key.

Flag	Description
--name	Required. Name of the API key to revoke.