npm package: @libstash/n8n-nodes-portainer-docker
Description: n8n nodes for Portainer and Docker API (through Portainer).
Author: konstantin
Latest version: 0.1.1

# @libstash/n8n-nodes-portainer-docker

This is an n8n community node. It lets you use Portainer and Docker API (through Portainer) in your n8n workflows.

[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/) workflow automation platform.

[Installation](#installation)
[Credentials](#credentials)
[Compatibility](#compatibility)
[Operations](#operations)
[Resources](#resources)
[License](#license)

## Installation

Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.

## Credentials

You need access token from your Portainer instance to use this node.

### Access token

1. Open your Portainer account [My account](http://localhost:9000/#!/account).
2. Scroll to "Access tokens".
3. And "+ Add access token"
4. Create token and copy it.

Refer to [Creating an access token](https://docs.portainer.io/api/access#creating-an-access-token) for more information.

## Compatibility

Compatible with n8n@1.60.0 or later

## Operations

<details>
  <summary>Docker operations</summary>

- ✅List containers
- ✅Create a container
- Inspect a container
- List processes running inside a container
- Get container logs
- Get changes on a container’s filesystem
- Export a container
- Get container stats based on resource usage
- Resize a container TTY
- Start a container
- Stop a container
- Restart a container
- Kill a container
- Update a container
- Rename a container
- Pause a container
- Unpause a container
- Attach to a container
- Attach to a container via a websocket
- Wait for a container
- Remove a container
- Get information about files in a container
- Get an archive of a filesystem resource in a container
- Extract an archive of files or folders to a directory in a container
- Delete stopped containers
- List Images
- Build an image
- Delete builder cache
- Create an image
- Inspect an image
- Get the history of an image
- Push an image
- Tag an image
- Remove an image
- Search images
- Delete unused images
- Check auth configuration
- Get system information
- Get version
- Ping
- Ping
- Create a new image from a container
- Monitor events
- Get data usage information
- Export an image
- Export several images
- Import images
- Create an exec instance
- Start an exec instance
- Resize an exec instance
- Inspect an exec instance
- List volumes
- Create a volume
- Inspect a volume
- Update a volume. Valid only for Swarm cluster volumes
- Remove a volume
- Delete unused volumes
- List networks
- Inspect a network
- Remove a network
- Create a network
- Connect a container to a network
- Disconnect a container from a network
- Delete unused networks
- List plugins
- Get plugin privileges
- Install a plugin
- Inspect a plugin
- Remove a plugin
- Enable a plugin
- Disable a plugin
- Upgrade a plugin
- Create a plugin
- Push a plugin
- Configure a plugin
- List nodes
- Inspect a node
- Delete a node
- Update a node
- Inspect swarm
- Initialize a new swarm
- Join an existing swarm
- Leave a swarm
- Update a swarm
- Get the unlock key
- Unlock a locked manager
- List services
- Create a service
- Inspect a service
- Delete a service
- Update a service
- Get service logs
- List tasks
- Inspect a task
- Get task logs
- List secrets
- Create a secret
- Inspect a secret
- Delete a secret
- Update a Secret
- List configs
- Create a config
- Inspect a config
- Delete a config
- Update a Config
- Get image information from the registry
- Initialize interactive session
</details>

<details>
  <summary>Portainer operations</summary>

- Authenticate
- Logout
- Authenticate with OAuth
- Creates an archive with a system data snapshot that could be used to restore the system.
- List available custom templates
- Remove a template
- Inspect a custom template
- Update a template
- Get Template stack file content.
- Fetch the latest config file content based on custom template's git repository configuration
- Create a custom template
- Create a custom template
- Create a custom template
- Fetch container gpus data
- Get counters for the dashboard
- Fetch images
- list EdgeGroups
- Create an EdgeGroup
- Deletes an EdgeGroup
- Inspects an EdgeGroup
- Updates an EdgeGroup
- Fetch EdgeJobs list
- Delete an EdgeJob
- Inspect an EdgeJob
- Update an EdgeJob
- Fetch a file of an EdgeJob
- Fetch the list of tasks on an EdgeJob
- Clear the log for a specifc task on an EdgeJob
- Fetch the log for a specifc task on an EdgeJob
- Collect the log for a specifc task on an EdgeJob
- Create an EdgeJob from a file
- Create an EdgeJob from a text
- Fetches the list of EdgeStacks
- Delete an EdgeStack
- Inspect an EdgeStack
- Update an EdgeStack
- Fetches the stack file for an EdgeStack
- Update an EdgeStack status
- Create an EdgeStack from file
- Create an EdgeStack from a git repository
- Create an EdgeStack from a text
- List Environment(Endpoint) groups
- Create an Environment(Endpoint) Group
- Remove an environment(endpoint) group
- Inspect an Environment(Endpoint) group
- Update an environment(endpoint) group
- Removes environment(endpoint) from an environment(endpoint) group
- Add an environment(endpoint) to an environment(endpoint) group
- Remove multiple environments
- List environments(endpoints)
- Create a new environment(endpoint)
- Remove an environment
- Inspect an environment(endpoint)
- Update an environment(endpoint)
- De-association an edge environment(endpoint)
- Upload a file under a specific path on the file system of an environment (endpoint)
- fetch docker pull limits
- Inspect an EdgeJob Log
- Inspect an Edge Stack for an Environment(Endpoint)
- Get environment(endpoint) status
- force update a docker service
- List Helm Releases
- Install Helm Chart
- Get a helm release
- Delete Helm Release
- Get a historical list of releases
- Rollback a helm release
- List Registries on environment
- update registry access for environment
- Update settings for an environment(endpoint)
- Snapshots an environment(endpoint)
- Remove multiple environments
- Create or retrieve the endpoint for an EdgeID
- Update relations for a list of environments
- Snapshot all environments(endpoints)
- preview the content of target file in the git repository
- Get a list of applications across all namespaces in the cluster. If the nodeName is provided, it will return the applications running on that node.
- Get Applications count
- Delete cluster role bindings
- Delete cluster roles
- Get a list of kubernetes cluster role bindings
- Get a list of kubernetes cluster roles
- Get a list of ConfigMaps
- Get ConfigMaps count
- Get a list of kubernetes Cron Jobs
- Delete Cron Jobs
- Get the dashboard summary data
- Get a description of a kubernetes resource
- Gets kubernetes events
- Get a list of ingress controllers
- Update (block/unblock) ingress controllers
- Get kubernetes ingresses at the cluster level
- Get Ingresses count
- Delete one or more Ingresses
- Get a list of kubernetes Jobs
- Delete Jobs
- Get max CPU and memory limits of all nodes within k8s cluster
- Get the total resource requests and limits of all applications
- Get a list of nodes with their live metrics
- Get live metrics for a node
- Get a list of pods with their live metrics
- Get live metrics for a pod
- Delete a kubernetes namespace
- Get a list of namespaces
- Create a namespace
- Update a namespace
- Get namespace details
- Update a namespace
- Get a ConfigMap
- Gets kubernetes events for namespace
- Get a list ingress controllers by namespace
- Update (block/unblock) ingress controllers by namespace
- Get a list of Ingresses
- Create an Ingress
- Update an Ingress
- Get an Ingress by name
- Get a Secret
- Get a list of services for a given namespace
- Create a service
- Update a service
- Toggle the system state for a namespace
- Get Kubernetes volumes within a namespace in the given Portainer environment
- Get the total number of kubernetes namespaces within the given Portainer environment.
- Get CPU and memory limits of all nodes within k8s cluster
- Check if RBAC is enabled
- Delete role bindings
- Get a list of kubernetes role bindings
- Get a list of kubernetes roles
- Delete roles
- Get a list of Secrets
- Get Secrets count
- Delete service accounts
- Get a list of kubernetes service accounts
- Get a list of services
- Get services count
- Delete services
- Get Kubernetes volumes within the given Portainer environment
- Get a Kubernetes volume within the given Portainer environment
- Get the total number of kubernetes volumes within the given Portainer environment.
- Generate a kubeconfig file
- Test LDAP connectivity
- fetches the message of the day
- Enable Portainer's OpenAMT capabilities
- Activate OpenAMT device and associate to agent endpoint
- Fetch OpenAMT managed devices information for endpoint
- Execute out of band action on an AMT managed device
- Enable features on an AMT managed device
- Request OpenAMT info from a node
- List Registries
- Create a new registry
- Remove a registry
- Inspect a registry
- Update a registry
- Configures a registry
- Create a new resource control
- Remove a resource control
- Update a resource control
- Triggers a system restore using provided backup file
- List roles
- Retrieve Portainer settings
- Update Portainer settings
- Retrieve Portainer public settings
- Inspect the ssl settings
- Update the ssl settings
- List stacks
- Remove a stack
- Inspect a stack
- Update a stack
- Associate an orphaned stack to a new environment(endpoint)
- Retrieve the content of the Stack file for the specified stack
- Update a stack's Git configs
- Redeploy a stack
- Migrate a stack to another environment(endpoint)
- Starts a stopped Stack
- Stops a stopped Stack
- Deploy a new kubernetes stack from a git repository
- Deploy a new kubernetes stack from a file
- Deploy a new kubernetes stack from a url
- Deploy a new compose stack from a file
- Deploy a new compose stack from repository
- Deploy a new compose stack from a text
- Deploy a new swarm stack from a file
- Deploy a new swarm stack from a git repository
- Deploy a new swarm stack from a text
- Remove Kubernetes stacks by name
- Webhook for triggering stack updates from git
- Check Portainer status
- Retrieve system info
- Retrieve the count of nodes
- Check Portainer status
- Upgrade Portainer to BE
- Check for portainer updates
- List tags
- Create a new tag
- Remove a tag
- List team memberships
- Create a new team membership
- Remove a team membership
- Update a team membership
- List teams
- Create a new team
- Remove a team
- Inspect a team
- Update a team
- List team memberships
- List available templates
- Get a template's file
- Search Helm Charts
- Show Helm Chart Information
- Upload TLS files
- List users
- Create a new user
- Remove a user
- Inspect a user
- Update a user
- List a users helm repositories
- Create a user helm repository
- Delete a users helm repositoryies
- Inspect a user memberships
- Update password for a user
- Get all API keys for a user
- Generate an API key for a user
- Remove an api-key associated to a user
- Check administrator account existence
- Initialize administrator account
- Inspect the current user user
- List webhooks
- Create a webhook
- Delete a webhook
- Execute a webhook
- Update a webhook
- Attach a websocket
- Execute a websocket
- Execute a websocket on kubectl shell pod
- Execute a websocket on pod

</details>

## Resources

- [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
- [Docker Engine API docs](https://docs.docker.com/reference/api/engine/#api-version-matrix)
- [Portainer API docs](https://docs.portainer.io/api/docs)

## License

[MIT](./LICENSE.md)