CLICommands
orl api-keys update
Edit an API key budget (needs `orl auth login`), part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing.
orl api-keys update <id>Sets, changes or removes an API key's spend budget and returns the key with its current spend. A limitNanoUsd of 0 removes the budget. Requires a signed-in session: your own key, or apikeys.write for any key. In organizations with permissions enabled, only the budget can be edited. Name, note and restrictions return 400. Available with permissions enabled; otherwise 404.
Flags
| Flag | Type | Required | |
|---|---|---|---|
--budget | json | no | A change to the key's spend budget. A field left out keeps its value, so a key without a budget needs limitNanoUsd; a limitNanoUsd of 0 removes the budget. A new limit on the same period keeps the spend counted so far in the period; a new period, or a budget on a key that had none, counts from the update. |
--name | string | no | |
--note | string | no | |
--restrictions | json | no | Refused with 400 in orgs with permissions enabled. Create a new key and revoke this one. |
--body | string | no | a JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"} |
--body-file | string | no | read the --body JSON object from a file (- for stdin) |
This wraps the updateOrgApiKey API operation.