PortainerInstall

Overview

This node operation allows you to remove an API key associated with a specific user in the system. It is useful for managing user access by revoking API keys that are no longer needed or have been compromised. For example, if a user's API key has been exposed or should no longer be valid, this operation can be used to delete that key and prevent further access.

Properties

Both properties are required to specify which user's API key should be removed.

Output

The output JSON structure is not explicitly detailed in the provided source code snippet. However, typically such an operation would return a confirmation of success or failure, possibly including status messages or the details of the removed key. The node does not appear to handle binary data output.

Dependencies

• Requires an API authentication token credential to connect to the Portainer API.
• The base URL for the API is configured via credentials.
• The node uses the Portainer API endpoint /api as its base path.

Troubleshooting

• Invalid User ID or Key ID: If either the user ID or API key ID does not exist, the API call will likely fail. Ensure both IDs are correct.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key credential is correctly set up.
• Network Issues: Connectivity problems to the Portainer API server will prevent the operation from completing.
• Permission Denied: The API key used must have sufficient permissions to remove user API keys.

Links and References

• Portainer API Documentation
• n8n Documentation on Credentials