Skip to main content

signaloid-cli keys list

List all API keys.

Synopsis​

signaloid-cli keys list

Options​

OptionDescription
--count <n>Maximum number of keys to show
--format <type>Output format:json or table (default: json)
--columns <cols>Columns to display (comma-separated) or 'help' to see available columns. Passing --columns selects table output. The CLI ignores unknown column names without an error.

Description​

Displays all API keys associated with your Signaloid account, including key IDs, names, creation dates, and expiration dates. The output never includes the secret value of a key.

Examples​

Basic Usage​

signaloid-cli keys list --format table

Output:

+----------------------------------+--------------------+-------------+-------------+
| Key ID | Name | Created | Valid Until |
|----------------------------------|--------------------|-------------|-------------|
| 582129bb6ea3453c9c6c93085c27c90a | Temporary Test Key | 08-Oct-2026 | 31-Dec-2027 |
| d190a75fbb14499dab9fa26ab2e76635 | Production API Key | 30-Oct-2025 | N/A |
+----------------------------------+--------------------+-------------+-------------+

Without --format table, the command prints JSON of the form {"Keys": [...]}.

Show Keys Expiring Soon​

# Current Unix timestamp in seconds
NOW=$(date +%s)

signaloid-cli keys list --format json | \
jq --arg now "$NOW" -r '.Keys[] |
select(.ValidUntil != null and .ValidUntil < ($now | tonumber) + 604800) |
"\(.Name) expires \(.ValidUntil)"'

Output Fields​

FieldTypeDescription
KeyIDstringUnique identifier for the key
NamestringDescriptive name given to the key
OwnerstringUser ID of key owner
CreatedAtnumberUnix timestamp (seconds) of key creation
ValidUntilnumber/nullUnix timestamp (seconds) when key expires, or null for no expiration

Notes​

  • The list output never includes the secret value of a key, or any part of it
  • CreatedAt and ValidUntil are Unix timestamps in seconds.
  • Keys with ValidUntil as null have no expiration date.
  • The keys API does not paginate, so --count only limits how many keys the CLI shows.
  • The order of the keys in the output is not guaranteed, and two consecutive calls can return the keys in a different order.

See Also​