CosmicAC Logo

Api Keys

Create, list, update, and revoke API keys. Uses the v1 API endpoints on the app node.

Create, list, update, and revoke API keys. Uses the v1 API endpoints on the app node.

Command

cosmicac api-keys <subcommand> [options]

Subcommands

SubcommandDescription
createCreate an API key
getGet API key details
listList API keys
revokeRevoke an API key
updateUpdate an API key
usageGet API key usage

api-keys create

Create a new API key. The full key value is only returned once at creation time.

Usage

cosmicac api-keys create <name> [options]

Arguments

ArgumentRequiredDescription
nameYesDisplay name for the API key

Options

OptionDescription
--expiry-atUnix timestamp when the key expires

api-keys get

Retrieve details for a single API key by ID.

Usage

cosmicac api-keys get <id>

Arguments

ArgumentRequiredDescription
idYesAPI key ID

api-keys list

List API keys owned by the authenticated user.

Usage

cosmicac api-keys list [options]

Options

OptionDescription
--pagePage number (default 1)
--page-sizeResults per page, 1-100 (default 20)
--statusFilter by status: active, revoked, or all (default all)
--sort-bySort field: created_at, updated_at, name, or last_used_at
--sort-orderSort direction: asc or desc (default desc)
--include-totalInclude total count in response metadata

api-keys revoke

Revoke an API key. Revoked keys cannot be used for authentication but usage history is preserved.

Usage

cosmicac api-keys revoke <id>

Arguments

ArgumentRequiredDescription
idYesAPI key ID

api-keys update

Rename an active API key.

Usage

cosmicac api-keys update <id> [options]

Arguments

ArgumentRequiredDescription
idYesAPI key ID

Options

OptionDescription
--nameNew display name

api-keys usage

Retrieve token and request usage statistics for one or more API keys.

Usage

cosmicac api-keys usage [options]

Options

OptionDescription
--api-key-idComma-separated API key IDs (defaults to all active keys)
--ts-startStart timestamp in milliseconds
--ts-endEnd timestamp in milliseconds
--granularityTime bucket size: hour, day, week, or month (default day)
--pagePage number for snapshot pagination
--page-sizeResults per page (default 50, max 200)
--sort-bySort field: timestamp, tokens_in, tokens_out, or requests
--sort-orderSort direction: asc or desc
--include-totalInclude total count in metadata

On this page