Portainer

Overview

This node integrates with the Portainer API to manage Docker volumes within a specified environment (endpoint). The "Get Many" operation for the "Volume" resource retrieves a list of all Docker volumes available in the selected environment. This is useful for scenarios where you need to inventory, monitor, or automate volume management tasks in your Docker infrastructure via Portainer.

Practical examples include:

• Listing all volumes to check storage usage or identify unused volumes.
• Automating cleanup workflows by retrieving volumes before deciding which to delete.
• Integrating volume data into dashboards or reports for operational visibility.

Properties

Output

The node outputs JSON data containing the list of Docker volumes retrieved from the Portainer API for the specified environment. The structure typically includes details about each volume such as its name, driver, mountpoint, labels, and usage information.

No binary data output is involved in this operation.

Dependencies

• Requires an active connection to a Portainer instance with API access.
• Needs an API key credential configured in n8n to authenticate requests to the Portainer API.
• The base URL of the Portainer API must be set in the credentials configuration.

Troubleshooting

• Common Issues:

  • Incorrect or missing Environment ID can cause the API request to fail or return no data.
  • Invalid or expired API key will result in authentication errors.
  • Network connectivity issues between n8n and the Portainer server may cause timeouts or failures.

• Error Messages:

  • Authentication errors usually indicate problems with the API key; verify and update credentials.
  • "Not Found" or similar errors may mean the specified environment ID does not exist or is inaccessible.
  • Rate limiting or permission denied errors require checking Portainer user permissions and API limits.

Links and References

• Portainer API Documentation
• Docker Volumes Documentation
• n8n Documentation on Credentials