signaloid-cli keys list
List all API keys.
Synopsis
signaloid-cli keys list
Options
| Option | Description |
|---|---|
--count <n> | Number of items to fetch using pagination |
--format <type> | Output format: json|table (default: table) |
--columns <cols> | Columns to display (comma-separated) or 'help' to see available columns |
Description
Displays all API keys associated with your Signaloid account, including key IDs, names, prefixes, creation dates, expiration dates, and last usage timestamps.
Examples
Basic Usage
signaloid-cli keys list
Output:
+----------------------------------+--------------------+----------------------+----------------------+
| Key ID | Name | Created | Valid Until |
|----------------------------------|--------------------|----------------------|----------------------|
| 582129bb6ea3453c9c6c93085c27c90a | Temporary Test Key | 21/01/1970, 10:23:52 | 31/12/2025, 23:59:59 |
| d190a75fbb14499dab9fa26ab2e76635 | Test Key | 21/01/1970, 10:23:52 | N/A |
+----------------------------------+--------------------+----------------------+----------------------+
Show Keys Expiring Soon
# Get current timestamp in milliseconds
NOW=$(date +%s)000
signaloid-cli keys list --format json | \
jq --arg now "$NOW" -r '.Keys[] |
select(.ValidUntil != null and (.ValidUntil | tonumber) < ($now | tonumber) + 604800000) |
"\(.Name) expires \(.ValidUntil)"'
Output Fields
| Field | Type | Description |
|---|---|---|
KeyID | string | Unique identifier for the key |
Name | string | Descriptive name given to the key |
Owner | string | User ID of key owner |
CreatedAt | string | ISO 8601 timestamp of key creation |
ValidUntil | number/null | Unix timestamp (milliseconds) when key expires, or null for no expiration |
Notes
- The full API key value is never displayed in list output, only the prefix
ValidUntilis expressed as Unix timestamp in milliseconds- Keys with
LastUsedasnullhave never been used for authentication - Keys with
ValidUntilasnullhave no expiration date
See Also
- signaloid-cli keys - Keys command overview
- signaloid-cli keys create - Create a new API key
- signaloid-cli keys delete - Delete an API key
- signaloid-cli auth - Authentication commands