Actions277
- User Agents Actions
- Url Filters Actions
- Users Actions
- Traffic Reports Actions
- Traffic Reports Qps Active Agents
- Traffic Reports Qps Active Users
- Traffic Reports Qps Active Collections
- Traffic Reports Top Domains
- Traffic Reports Top Categories
- Traffic Reports Top Application Categories
- Traffic Reports Top Organizations
- Traffic Reports Top Networks
- Traffic Reports Top Agents
- Traffic Reports Top Users
- Traffic Reports Top Collections
- Traffic Reports Query Logs
- Traffic Reports Total Organizations Stats
- Traffic Reports Total Domain Stats
- Traffic Reports Total Category Stats
- Traffic Reports Total Organizations Requests
- Traffic Reports Total Domain Requests
- Traffic Reports Top Organizations Requests
- Traffic Reports Total Client Stats
- Traffic Reports Total Deployments
- Traffic Reports Total Roaming Clients
- Traffic Reports Total Applications Stats
- Traffic Reports Total Applications Organizations Stats
- Traffic Reports Total Applications Networks Stats
- Traffic Reports Total Applications Agents Stats
- Traffic Reports Total Applications Users Stats
- Traffic Reports Total Applications Collections Stats
- Traffic Reports Total Requests
- Traffic Reports Total Requests Geo
- Traffic Reports Total Requests Organizations
- Traffic Reports Total Requests Agents
- Traffic Reports Total Requests Users
- Traffic Reports Total Requests Collections
- Traffic Reports Total Threats
- Traffic Reports Total Threats Organizations
- Traffic Reports Total Threats Agents
- Traffic Reports Total Threats Users
- Traffic Reports Total Threats Collections
- Traffic Reports Total Categories
- Traffic Reports Total Categories Organizations
- Traffic Reports Total Categories Agents
- Traffic Reports Total Categories Users
- Traffic Reports Total Categories Collections
- Traffic Reports Total Domains
- Traffic Reports Total Domains Organizations
- Traffic Reports Total Domains Users
- Traffic Reports Total Domains Collections
- Traffic Reports Total Collections
- Traffic Reports Total Collections Organizations
- Traffic Reports Total Collections Agents
- Traffic Reports Total Collections Users
- Traffic Reports Qps
- Traffic Reports Qps Active Organizations
- Trials Actions
- User Agent Bulk Deletes Actions
- User Agent Bulk Updates Actions
- User Agent Cleanups Actions
- User Agent Csv Exports Actions
- Policies Actions
- Policies Add Blacklist Category
- Policies Remove Blacklist Category
- Policies Add Allowed Application
- Policies Remove Allowed Application
- Policies Add Blocked Application
- Policies Remove Blocked Application
- Policies Get Permissive Mode
- Policies Index
- Policies Create
- Policies All
- Policies Show
- Policies Update
- Policies Destroy
- Policies Application
- Policies Application Update
- Policies Add Blacklist Domain
- Policies Remove Blacklist Domain
- Policies Add Whitelist Domain
- Policies Remove Whitelist Domain
- Policies Bulk Actions Actions
- Policy Ips Actions
- Scheduled Policies Actions
- Scheduled Report Previews Actions
- Scheduled Reports Actions
- Networks Actions
- Networks Lookup
- Networks Show
- Networks Update
- Networks Destroy
- Networks Bulk Create
- Networks Bulk Create Status
- Networks Index
- Networks Create
- Networks All
- Networks Msp
- Networks Msp All
- Networks Bulk Update
- Networks Bulk Update Status
- Networks Bulk Destroy
- Networks Bulk Destroy Status
- Networks Generate Secret Key
- Networks Revoke Secret Key
- Networks Rotate Secret Key
- Mac Addresses Actions
- Metrics Actions
- Network Lan Ips Actions
- Network Subnets Actions
- Organizations Actions
- Organization Users Actions
- Distributors Actions
- Distributors Msps Cancel
- Distributors Msps Reactivate
- Distributors Organizations Index
- Distributors Organizations Create
- Distributors Organizations Show
- Distributors Organizations Update
- Distributors Organizations Cancel
- Distributors Organizations Reactivate
- Distributors Organizations Add Sku
- Distributors Organizations Remove Sku
- Distributors Users Index
- Distributors Users Create
- Distributors Users Show
- Distributors Users Add Membership
- Distributors Users Update Membership
- Distributors Users Remove Membership
- Distributors Users Send Reset Password Email
- Distributors Users Reset Password Url
- Distributors Reports Usage By Organization
- Distributors Reports Usage By Sku
- Distributors Reports Covered Users Summary By Organization
- Distributors Distributors Update
- Distributors Msps Index
- Distributors Msps Create
- Distributors Msps Show
- Distributors Msps Update
- Domain Notes Actions
- Domains Actions
- Enterprise Connections Actions
- Invoices Actions
- IP Addresses Actions
- Allowed Urls Actions
- Api Key Actions
- Application Categories Actions
- Applications Actions
- Authentication Actions
- Authentication Sync Tool Actions
- Billings Actions
- Blocked Urls Actions
- Block Pages Actions
- Categories Actions
- Collection Users Actions
- Agent Local User Actions
- Agent Local User Bulk Deletes Actions
Overview
This node operation retrieves a list (index) of API keys from an external service. It allows filtering the results by various optional query parameters such as whether the key is expired, its ID, last four characters of the token, name, or associated organization ID. This functionality is useful for managing and auditing API keys programmatically, for example, to monitor active keys, identify expired ones, or find keys related to specific organizations.
Practical examples include:
- Fetching all expired API keys to clean up or revoke them.
- Searching for an API key by its last four digits for verification.
- Listing all API keys belonging to a particular organization.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional filters to narrow down the API key list. Possible fields: |
| - Expired: boolean indicating if the API key is expired or not. | |
| - Id: numeric ID of the API key. | |
| - Last Four: string representing the last four characters of the API key token. | |
| - Name: string name of the API key. | |
| - Organization Id: numeric ID of the organization associated with the API key. |
Output
The node outputs JSON data containing the list of API keys matching the query parameters. Each item in the output typically includes details about an API key such as its ID, name, expiration status, last four characters of the token, and associated organization ID. The exact structure depends on the external API's response schema.
No binary data output is indicated.
Dependencies
- Requires an API key credential to authenticate requests to the external API service.
- The base URL for the API requests is set to
https://api.dnsfilter.com. - The node uses standard HTTP headers for JSON content (
AcceptandContent-Type).
Troubleshooting
Common issues:
- Authentication failures due to missing or invalid API credentials.
- Incorrect query parameter values causing no results or errors.
- Network connectivity problems preventing access to the API endpoint.
Error messages:
- Unauthorized or 401 errors indicate invalid or missing API authentication.
- 400 Bad Request errors may result from invalid query parameters; verify parameter types and values.
- Timeout or network errors suggest connectivity issues; check internet connection and API availability.
Links and References
- API Key Management Documentation (Replace with actual link if available)
- DNSFilter API Reference