Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Overview

This node interacts with Docker through the Portainer API, specifically allowing users to list Docker plugins available on a selected endpoint. It is useful for scenarios where you want to programmatically retrieve and manage Docker plugins in your infrastructure managed by Portainer. For example, you might use this node to audit installed plugins, filter plugins by capabilities or enabled status, or integrate plugin data into broader automation workflows.

Properties

Name Meaning
EndpointID Name or ID The identifier of the Portainer endpoint to access. You can select from a dynamically loaded list of endpoints or specify an ID using an expression. This determines which Docker environment the plugin list will be fetched from.
Additional Fields Optional extra parameters to refine the plugin list request. Currently supports:
- Filters: A JSON-encoded string representing filters to apply on the plugin list. Available filters include:
  • capability=<capability name>
  • `enable=

Output

The node outputs JSON data containing the list of Docker plugins retrieved from the specified Portainer endpoint. Each item in the output corresponds to a plugin object as returned by the Portainer API, including details such as plugin name, capabilities, enabled status, and other metadata. There is no binary data output.

Dependencies

  • Requires a valid connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests to the Portainer API.
  • The node dynamically loads available endpoints from the Portainer API to populate the "EndpointID" property.

Troubleshooting

  • Common issues:
    • Incorrect or missing endpoint ID may cause the node to fail to fetch plugin data.
    • Invalid or expired API credentials will result in authorization errors.
    • Malformed JSON in the Filters field can cause query parameter parsing errors.
  • Error messages:
    • Authorization errors typically indicate invalid API credentials; verify and update the credential configuration.
    • Network or connection errors suggest issues reaching the Portainer API URL; check network connectivity and base URL correctness.
    • JSON parse errors for filters mean the input is not valid JSON; ensure proper JSON formatting.

Links and References

Discussion