PortainerInstall

Overview

This node interacts with the Portainer API to manage Edge Jobs, specifically allowing users to retrieve the file associated with a particular Edge Job by its ID. It is useful in scenarios where automation workflows need to access or manipulate Edge Job files programmatically, such as downloading job definitions for backup, inspection, or deployment purposes.

Properties

Output

The node outputs JSON data representing the file content or metadata of the specified Edge Job. This typically includes the job's configuration or script details as returned by the Portainer API. If the node supports binary data output (not explicitly shown in the provided code), it would represent the actual file content of the Edge Job.

Dependencies

• Requires an API key credential for authenticating with the Portainer API.
• Needs the base URL of the Portainer instance configured in the credentials.
• Depends on the @devlikeapro/n8n-openapi-node package and the OpenAPI specification (openapi.json) bundled with the node for API interaction.

Troubleshooting

• Invalid or missing Edge Job ID: Ensure the "Id" property is set correctly and corresponds to an existing Edge Job in Portainer.
• Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access Edge Jobs.
• Network issues: Confirm that the Portainer instance URL is reachable from the n8n environment.
• Unexpected API responses: Check if the Portainer API version matches the one expected by the node; mismatches can cause failures.

Links and References

• Portainer API Documentation
• n8n Custom Node Development