h2oGPTe icon

h2oGPTe

h2oGPTe is an AI-powered search assistant for your internal teams to answer questions gleaned from large volumes of documents, websites and workplace content.

Actions198

Overview

This node allows administrators to deactivate an existing API key within the system. Deactivating an API key is useful when you want to immediately revoke access granted by that key without deleting it permanently. This can be beneficial in scenarios such as compromised keys, temporary suspension of access, or rotating keys for security purposes.

For example, if an API key has been exposed or is no longer needed temporarily, this node can be used to deactivate it, preventing any further use until reactivated or replaced.

Properties

Name Meaning
Key ID The unique identifier of the API key to deactivate

Output

The output will contain the full HTTP response from the API call to deactivate the specified API key. This typically includes status information indicating whether the deactivation was successful. The json field will hold the parsed response body, which may include confirmation details or error messages.

No binary data is expected in the output.

Dependencies

  • Requires an API authentication credential configured in n8n to authorize requests.
  • The node sends a POST request to the endpoint /admin/api_keys/deactivate/{key_id} where {key_id} is the provided API key ID.
  • The base URL and authentication headers are derived from the configured credentials.

Troubleshooting

  • Invalid Key ID: If the provided Key ID does not exist or is malformed, the API will likely return an error. Verify the Key ID is correct.
  • Insufficient Permissions: Only users with administrative privileges can deactivate API keys. Ensure the API credential used has the necessary permissions.
  • Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures. Check network connectivity and credential settings.
  • API Errors: The API might return errors if the key is already deactivated or if there are internal server issues. Review the error message returned in the response for guidance.

Links and References

  • Refer to your platform's API documentation for managing API keys and their lifecycle.
  • Consult n8n documentation on setting up API credentials and using HTTP request nodes for custom integrations.

Discussion