portainer

Custom n8n node for full integration with the Portainer API 2.27.8 — 100% coverage with 21 resources and 150+ operations including Docker Containers, Images, Services, Swarm, Networks, Volumes, Stacks, Secrets, Configs, Nodes, Templates, Registries, Teams

Package Information

Released: 5 mo ago
Downloads: 51 weeklyĀ /Ā 303 monthly
Latest Version: 2.1.5
Author: Ramon Matias

Documentation

n8n-nodes-portainer


This Community Node is a 100% free solution, created to simplify and help the community integrate and fully leverage the main features offered by Portainer in n8n workflows.


Downloads Badge Version Badge License Badge

Email GitHub NPM

Notice: This node was developed independently to make it easier to integrate with Portainer's public API in n8n.
It is not affiliated with, endorsed by, or maintained by Portainer.
All referenced trademarks belong to their respective owners.

āš™ļø Requirements

To use this Community Node, you need:

  • n8n version 1.54.4 or newer
  • Node.js version 16.0.0 or newer
  • An active Portainer account with an API token

šŸ“Œ Available Resources

🐳 Containers

šŸ“ Full Docker container management with advanced operations for creation, execution, monitoring, and lifecycle control.
Operations
āœ… Create - Create new containers
āœ… Delete - Delete containers
āœ… Exec - Execute commands in containers
āœ… Get - Get specific container information
āœ… Get Logs - Get container logs
āœ… Get Many - List all containers
āœ… Get Stats - Get usage statistics
āœ… Inspect - Inspect container details
āœ… Pause - Pause running containers
āœ… Restart - Restart containers
āœ… Start - Start stopped containers
āœ… Stop - Stop running containers
āœ… Unpause - Unpause paused containers

šŸ–¼ļø Images

šŸ“ Full Docker image management including build, pull, push, tagging, and history inspection for lifecycle control.
Operations
āœ… Build - Build images from a Dockerfile
āœ… Delete - Delete images
āœ… Get - Get specific image information
āœ… Get History - Get image history
āœ… Get Many - List all images
āœ… Inspect - Inspect image details
āœ… Pull - Pull images from a registry
āœ… Push - Push images to a registry
āœ… Tag - Create tags for images

āš™ļø Services (Docker Swarm)

šŸ“ Full Docker Swarm service management with creation, scaling, updates, and monitoring for distributed container orchestration.
Operations
āœ… Create - Create new services
āœ… Delete - Delete services
āœ… Get - Get specific service information
āœ… Get Logs - Get service logs
āœ… Get Many - List all services
āœ… Scale - Scale number of replicas
āœ… Update - Update service configuration

šŸ” Secrets (Docker Swarm)

šŸ“ Secure Docker Swarm secret management for storing and safely distributing sensitive information to services.
Operations
āœ… Create - Create new secrets
āœ… Delete - Delete secrets
āœ… Get - Get specific secret information
āœ… Get Many - List all secrets
āœ… Inspect - Inspect secret details

šŸ“‹ Configs (Docker Swarm)

šŸ“ Docker Swarm config management for distributing configuration files and non-sensitive data to cluster services.
Operations
āœ… Create - Create new configs
āœ… Delete - Delete configs
āœ… Get - Get specific config information
āœ… Get Many - List all configs
āœ… Inspect - Inspect config details

🌐 Edge Groups

šŸ“ Edge computing group management for organizing and centrally controlling geographically distributed endpoints.
Operations
āœ… Create - Create new edge groups
āœ… Delete - Delete edge groups
āœ… Get - Get specific group information
āœ… Get Many - List all edge groups
āœ… Update - Update group settings

šŸ“¦ Edge Stacks

šŸ“ Edge stack management for distributed deployment of applications across multiple edge locations.
Operations
āœ… Create - Create new edge stacks
āœ… Delete - Delete edge stacks
āœ… Get - Get specific stack information
āœ… Get Many - List all edge stacks
āœ… Get Status - Get deployment status
āœ… Update - Update stack settings

šŸ–„ļø Nodes (Docker Swarm)

šŸ“ Docker Swarm node management for monitoring and controlling cluster nodes, including status and settings.
Operations
āœ… Get - Get specific node information
āœ… Get Many - List all nodes
āœ… Inspect - Inspect node details
āœ… Update - Update node settings

šŸ“š Stacks (Docker Compose)

šŸ“ Docker Compose stack management for deploying and updating multi-container applications defined in YAML files.
Operations
āœ… Delete - Delete stacks
āœ… Get - Get specific stack information
āœ… Get Many - List all stacks
āœ… Update - Update stack settings

šŸ“‹ Registries

šŸ“ Docker image registry management with support for multiple types including DockerHub, ECR, Azure, GitLab, and custom registries.
Operations
āœ… Create - Create new registries
āœ… Delete - Delete registries
āœ… Get - Get specific registry information
āœ… Get Many - List all registries
āœ… Update - Update registry settings

šŸ‘„ Teams

šŸ“ Portainer team management for group-based access control and collaborative permissions.
Operations
āœ… Create - Create new teams
āœ… Delete - Delete teams
āœ… Get - Get specific team information
āœ… Get Many - List all teams
āœ… Update - Update team settings

šŸ“„ Templates

šŸ“ Portainer application template management for fast deployment of pre-configured applications.
Operations
āœ… Get - Get specific template information
āœ… Get Many - List all templates

āš™ļø Settings

šŸ“ Portainer settings management including authentication, security policies, and global platform settings.
Operations
āœ… Get - Get current settings
āœ… Update - Update settings

šŸ”— Webhooks

šŸ“ Webhook management for automation and integration with external systems via HTTP notifications.
Operations
āœ… Create - Create new webhooks
āœ… Delete - Delete webhooks
āœ… Get Many - List all webhooks

šŸ’» System

šŸ“ Portainer system information including status, version, and node information for platform monitoring.
Operations
āœ… Get Status - Get system status
āœ… Get Version - Get Portainer version
āœ… Get Nodes - Get node information

šŸ‘¤ Users

šŸ“ Portainer user management for access control and account administration.
Operations
āœ… Get - Get specific user information
āœ… Get Many - List all users

šŸ’¾ Volumes

šŸ“ Docker volume management for data persistence and sharing between containers.
Operations
āœ… Delete - Delete volumes
āœ… Get Many - List all volumes

🌐 Networks

šŸ“ Docker network management for connectivity and isolation between containers.
Operations
āœ… Delete - Delete networks
āœ… Get Many - List all networks

šŸ¢ Environments

šŸ“ Portainer environment/endpoint management for connecting to different Docker instances.
Operations
āœ… Get - Get specific environment information
āœ… Get Many - List all environments

šŸš€ Installation

Via n8n Community Nodes:

  1. Open your n8n instance
  2. Go to Settings → Community Nodes
  3. Install the package: n8n-nodes-portainer
  4. Restart n8n

Via NPM:

npm install n8n-nodes-portainer

šŸ¤ Contributing

Help this project grow! You can contribute in several ways:

  • Pull Requests: Send improvements, fixes, or new features.
  • Issues: Report bugs or suggest ideas.
  • Feedback: Share your thoughts and suggestions.
  • Documentation: Help improve or expand the existing docs.

Built with ā¤ļø by Ramon Matias

Discussion