veirox api-key
Manage API keys
Synopsis
veirox api-key <subcommand> [args] [flags]
Description
Manage API keys
Subcommands
| Command | Description |
|---|---|
veirox api-key create | Mint a new API key |
veirox api-key info <key-id> | Show one API key (no plaintext) |
veirox api-key list | List API keys for the active org |
veirox api-key revoke <key-id> | Revoke an API key |
veirox api-key rotate <key-id> | Rotate an API key (issues a new plaintext) |
veirox api-key create
Mint a new API key
| Flag | Type | Default | Description |
|---|---|---|---|
--name | string | โ | human-readable key name |
--project-id | stringSlice | [] | restrict key to project uuid(s) |
--role | string | member | viewer | member | admin |
--scope | stringSlice | [] | scope (repeat for multiple) |
--ttl-days | int | 0 | expire after N days (0 = no expiry) |
veirox api-key create --name ci --role member --scope tasks:trigger --project-id <uuid>
veirox api-key info <key-id>
Show one API key (no plaintext)
veirox api-key info <uuid>
veirox api-key list
List API keys for the active org
veirox api-key list
veirox api-key revoke <key-id>
Revoke an API key
| Flag | Type | Default | Description |
|---|---|---|---|
--yes | bool | false | confirm revoke |
veirox api-key revoke <uuid> --yes
veirox api-key rotate <key-id>
Rotate an API key (issues a new plaintext)
veirox api-key rotate <uuid>
Exit codes
| Code | Meaning |
|---|---|
0 | Success. |
1 | Generic error (network, API 5xx). |
2 | Validation error (bad flag, missing required arg). |
3 | Unauthenticated โ run veirox login or set VEIROX_API_KEY. |
4 | Not found (resource does not exist in this project). |
5 | Permission denied (your role / API key lacks the scope). |
See also
- ๐ Configuration
- ๐ Reference: veirox login
- ๐ Reference: veirox project