Actions26
Overview
This node provides integration with the GateKit API, a universal messaging gateway that supports multiple resources and operations related to projects, members, platforms, messages, API keys, and platform logs. Specifically, for the ApiKeys resource with the Revoke operation, the node allows you to revoke (invalidate) an existing API key associated with a project.
Use cases include:
- Revoking compromised or no longer needed API keys to maintain security.
- Managing API keys lifecycle within your projects programmatically.
- Automating API key revocation as part of a larger workflow when user access changes.
Example: You have an API key that was accidentally exposed; you can use this node to revoke it immediately by specifying the project and the key ID.
Properties
| Name | Meaning |
|---|---|
API key ID to revoke (keyId) |
The unique identifier of the API key you want to revoke. This is required. |
Project Slug (projectSlug) |
The identifier (slug) of the project where the API key exists. Defaults to "default". |
Note: There are duplicate definitions of keyId in the provided properties, but they all refer to the same concept — the API key's unique ID to revoke.
Output
The node outputs the JSON response from the GateKit API after attempting to revoke the specified API key. Typically, this will be a confirmation of successful revocation or an error message if the operation failed.
The output JSON structure depends on the API response but generally includes status information about the revoked key.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential for authenticating requests to the GateKit API.
- The node uses the base URL configured in the credentials (
apiUrl). - Proper permissions to revoke API keys in the specified project are necessary.
Troubleshooting
- Invalid API key ID: If the
keyIddoes not exist or is incorrect, the API will return an error. Verify the key ID before revoking. - Insufficient permissions: Ensure the API key used for authentication has rights to revoke keys in the target project.
- Project slug errors: Using an incorrect or non-existent project slug will cause failures. Confirm the project identifier.
- Network or API errors: Check connectivity and API availability if requests fail unexpectedly.
Common error messages typically come directly from the API and should be interpreted accordingly.
Links and References
- GateKit API Documentation (Assumed official docs for more details on API keys management)
- n8n documentation on HTTP Request Node for understanding how API calls are made internally.