docs

ix

ix keys

Mint and manage API keys: one capped key per user or per agent, over the account's single balance

Usage: ix keys [OPTIONS] [COMMAND]

commands

  • ix keys create Mint an API key. The secret is printed once, here, and cannot be recovered afterwards -- store it before the terminal scrolls
  • ix keys ls List the account's API keys and what they have spent
  • ix keys self Show the key this CLI is authenticated with: its cap, spend and headroom. Takes no id -- a capped key can read itself without being able to read its siblings
  • ix keys get Show one key by id, at any depth and whatever its state -- revoked included. To read the key you are authenticated with, use `ix keys self`, which needs no id and no account-wide read
  • ix keys update Change a key's label, cap, or paused state. A revoked key cannot be updated: revocation is terminal
  • ix keys revoke Permanently revoke a key and every key beneath it. Not reversible; to pause a key instead, use `ix keys update <id> --disable`

options

  • --output <OUTPUT> Output format one of: human, json default: human
  • --message-format <MESSAGE_FORMAT> Error format one of: human, short, json default: human