Overview

This node interacts with the Typesense search platform, specifically supporting operations on various resources including API keys. The 'Get' operation for the 'API Key' resource retrieves details of a specific API key by its ID. This is useful for managing and auditing API keys in a Typesense environment, such as fetching key details for validation or monitoring purposes.

Use Case Examples

1. Retrieve details of a specific API key by providing its ID to verify its permissions and status.
2. Filter the output columns to get only relevant information about an API key, such as its name and expiration date.

Properties

Output

JSON

• id - The unique identifier of the API key.
• name - The name of the API key.
• description - Description or notes about the API key.
• actions - The actions or permissions granted to the API key.
• collections - The collections the API key has access to.
• expires_at - The expiration timestamp of the API key.

Dependencies

• Typesense API key credential for authentication

Troubleshooting

• If the API Key ID is missing or incorrect, the node will fail to retrieve the key details. Ensure the ID is correct and the key exists.
• If the Typesense API credentials are invalid or missing, authentication errors will occur. Verify the API key credential configuration.
• Network or connectivity issues to the Typesense server can cause request failures. Check network settings and server availability.

Links

• Typesense API - Get an API Key - Official Typesense API documentation for retrieving an API key's details.