PortainerInstall

Overview

This node allows you to create a Docker Swarm stack in a specified environment by sending a stack configuration string to the Portainer API. It is useful for automating deployment of containerized applications managed via Docker Swarm, especially when you want to programmatically manage stacks through n8n workflows.

Typical use cases include:

• Deploying or updating multi-container applications defined as stacks on remote Docker Swarm environments.
• Integrating stack deployment into CI/CD pipelines.
• Managing multiple Docker environments from a single automation platform.

Properties

Output

The node outputs JSON data representing the response from the Portainer API after attempting to create the stack. This usually includes details about the created stack such as its ID, name, and status. No binary data output is involved.

Dependencies

• Requires an API key credential for authenticating with the Portainer API.
• Needs the base URL of the Portainer instance configured in credentials.
• The node depends on the Portainer API being accessible and the specified environment (endpoint) existing in Portainer.

Troubleshooting

• Invalid Endpoint Id: If the endpoint ID does not correspond to a valid environment, the API call will fail. Verify the environment exists and the ID is correct.
• Malformed Stack Config: Providing an invalid or improperly formatted stack configuration string may cause the API to reject the request. Ensure the body contains valid Docker Compose YAML or compatible stack definition.
• Authentication Errors: Missing or incorrect API credentials will result in authentication failures. Confirm that the API key and URL are correctly set in the node credentials.
• Network Issues: Connectivity problems between n8n and the Portainer server can cause timeouts or connection errors. Check network access and firewall settings.

Links and References

• Portainer API Documentation
• Docker Swarm Stacks
• Docker Compose File Reference