veirox api-key

Manage API keys

Synopsis

veirox api-key <subcommand> [args] [flags]

Description

Manage API keys

Subcommands

CommandDescription
veirox api-key createMint a new API key
veirox api-key info <key-id>Show one API key (no plaintext)
veirox api-key listList 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

FlagTypeDefaultDescription
--namestringโ€”human-readable key name
--project-idstringSlice[]restrict key to project uuid(s)
--rolestringmemberviewer | member | admin
--scopestringSlice[]scope (repeat for multiple)
--ttl-daysint0expire 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

FlagTypeDefaultDescription
--yesboolfalseconfirm 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

CodeMeaning
0Success.
1Generic error (network, API 5xx).
2Validation error (bad flag, missing required arg).
3Unauthenticated โ€” run veirox login or set VEIROX_API_KEY.
4Not found (resource does not exist in this project).
5Permission denied (your role / API key lacks the scope).

See also