Skip to content

Commit

Permalink
[CLOUDGA-25138] Added doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bhupendray-yb committed Jan 20, 2025
1 parent 3f39e24 commit 44e4a75
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/ybm_api-key_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@ ybm api-key create [flags]
### Options

```
--name string [REQUIRED] The name of the API Key.
--duration int32 [REQUIRED] The duration for which the API Key will be valid. 0 denotes that the key will never expire.
--unit string [REQUIRED] The time units for which the API Key will be valid. Available options are Hours, Days, and Months.
--description string [OPTIONAL] Description of the API Key to be created.
--role-name string [OPTIONAL] The name of the role to be assigned to the API Key. If not provided, an Admin API Key will be generated.
-f, --force Bypass the prompt for non-interactive usage
-h, --help help for create
--name string [REQUIRED] The name of the API Key.
--duration int32 [REQUIRED] The duration for which the API Key will be valid. 0 denotes that the key will never expire.
--unit string [REQUIRED] The time units for which the API Key will be valid. Available options are Hours, Days, and Months.
--description string [OPTIONAL] Description of the API Key to be created.
--network-allow-lists string [OPTIONAL] The network allow lists(comma separated names) to assign to the API key.
--role-name string [OPTIONAL] The name of the role to be assigned to the API Key. If not provided, an Admin API Key will be generated.
-f, --force Bypass the prompt for non-interactive usage
-h, --help help for create
```

### Options inherited from parent commands
Expand All @@ -28,6 +29,7 @@ ybm api-key create [flags]
-a, --apiKey string YugabyteDB Aeon account API key
--config string config file (default is $HOME/.ybm-cli.yaml)
--debug Use debug mode, same as --logLevel debug
--host string YugabyteDB Aeon Api hostname
-l, --logLevel string Select the desired log level format(info). Default to info
--no-color Disable colors in output , default to false
-o, --output string Select the desired output format (table, json, pretty). Default to table
Expand Down

0 comments on commit 44e4a75

Please sign in to comment.