docs

ix keys

ix keys create

Mint an API key. The secret is printed once, here, and cannot be recovered afterwards -- store it before the terminal scrolls

Usage: ix keys create [OPTIONS] <NAME>

arguments

  • <NAME> Label for the key. Not an identifier; pick something that says whose it is (e.g. user_4711)

options

  • --limit <USD> Spend cap, in US dollars. A cap is a circuit breaker on the shared account balance, not a transfer: --limit 25 moves no money, it stops this key spending past $25. Uncapped without it
  • --scope <RESOURCE:ACTIONS> Permission grant, repeatable, as resource:action[,action..] (e.g. --scope vm:*). Bounded by what the calling identity already holds. Inherits the caller's permissions when omitted
  • --rate-limit <N> Requests per minute this key may issue
  • --output <OUTPUT> Output format one of: human, json default: human
  • --message-format <MESSAGE_FORMAT> Error format one of: human, short, json default: human