For security reasons, the actual API key values are never returned. Only the
key prefix (first 8 characters) is shown for identification.
Request
Your API key for authentication
Response
Always
true
for successful requestsArray of API key objects
Use Cases
1. API Key Audit
Review all API keys and their permissions:2. Clean Up Unused Keys
Identify and potentially remove unused API keys:3. Permission Analysis
Analyze permission distribution across keys:4. Expiration Monitoring
Monitor keys approaching expiration:Filtering and Analysis
While the API doesn’t support query parameters for filtering, you can filter results client-side:Error Responses
Unauthorized (401)
Rate Limited (429)
Security Considerations
Key Identification
Key Identification
Use the
prefix
field to identify keys in logs and configurations:
javascript console.log(`Request made with key: ${apiKey.substring(0, 8)} ***`);
Regular Audits
Regular Audits
Regularly review your API keys: - Remove unused keys - Rotate keys approaching
expiration - Review permissions for least privilege
Monitoring
Monitoring
Monitor for suspicious activity: - Sudden usage spikes - Keys used from
unexpected locations - High error rates from specific keys