PortainerInstall

Overview

This node performs a backup operation for the "Backup" resource by sending a request to create a backup, optionally encrypting it with a provided password. It is useful in scenarios where you want to programmatically trigger backups of your system or application data and secure the backup with encryption.

For example, you might use this node to:

• Automate regular backups of your environment.
• Secure backups by providing a password to encrypt the backup file.
• Integrate backup creation into larger workflows that manage system maintenance or disaster recovery.

Properties

Output

The node outputs JSON data representing the result of the backup operation. This typically includes information about the created backup such as its status, location, or metadata returned by the API. The exact structure depends on the API response but generally confirms successful backup creation.

No binary data output is indicated in the source code.

Dependencies

• Requires an API key credential for authentication to the Portainer API.
• Needs the base URL of the Portainer instance configured in credentials.
• Depends on the Portainer API being accessible and properly configured to accept backup requests.

Troubleshooting

• Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
• Connection issues: Verify the base URL is correct and the Portainer server is reachable.
• Invalid body format: The "Body" property must be a valid JSON string containing the encryption password; malformed JSON will cause errors.
• API errors: Check the API response message for details if the backup fails (e.g., insufficient permissions, invalid parameters).

Links and References

• Portainer API Documentation
• n8n Documentation - Creating Custom Nodes