mba-cli key

3 commands

Read API keys (key-scoped)

Synopsis#

bash

mba-cli key <command> [flags]

Available commands#

mba-cli key getGet one API key by id

Retrieve an API key by id Returns the metadata for a single API key by `id` (never the secret). Related: `List API keys`. Get one API key by id

--id

string

API key record id

GET/management/api-keys/{id}

mba-cli key lsList API keys

List API keys Returns the API keys for the tenant identified by the API key. Secret values are never returned, only metadata (name, prefix, scopes, usage). Related: `Retrieve an API key`, `Retrieve API key usage`. List API keys

--all	bool = false	Return all keys (paginate=false)
--limit	int = 20	Items per page
--page	int = 1	Page number

GET/management/api-keys

mba-cli key usageShow API key usage (tenant-wide, or one key with --id)

Retrieve tenant API key usage Returns monthly usage statistics for all API keys in the tenant. Related: `Retrieve API key usage`. --- Retrieve API key usage Returns daily usage statistics for a single API key by `id`. Related: `Retrieve tenant API key usage`. Show API key usage (tenant-wide, or one key with --id)

--days	int = 0	Key usage window in days
--id	string	API key record id (omit for tenant usage)
--months	int = 0	Tenant usage window in months

GET/management/api-keys/usage GET/management/api-keys/{id}/usage

Was this page helpful?