Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Overview

This node interacts with Docker through the Portainer API, specifically allowing users to inspect Docker plugins on a selected endpoint. It is useful for scenarios where you need to retrieve detailed information about a specific Docker plugin installed or available on a Docker environment managed by Portainer.

Practical examples include:

  • Automating audits of Docker plugins across multiple endpoints.
  • Integrating plugin inspection into CI/CD pipelines to verify plugin versions or configurations.
  • Monitoring and managing Docker environments programmatically via n8n workflows.

Properties

Name Meaning
EndpointID Name or ID The identifier of the Docker endpoint managed by Portainer where the plugin resides. You can select from a list of available endpoints or specify an ID directly.
Name The name of the Docker plugin to inspect. The :latest tag is optional and assumed if omitted.

Output

The node outputs JSON data containing detailed information about the specified Docker plugin as returned by the Portainer API. This typically includes metadata such as plugin configuration, version, enabled status, and other relevant plugin details.

No binary data output is indicated.

Dependencies

  • Requires access to a Portainer instance with the Portainer API enabled.
  • Needs an API authentication token or key configured in n8n credentials to authenticate requests to the Portainer API.
  • The node dynamically loads available Docker endpoints from the Portainer API to populate the endpoint selection property.

Troubleshooting

  • Common issues:

    • Invalid or missing endpoint ID: Ensure the endpoint exists and is accessible via the configured Portainer API credentials.
    • Incorrect plugin name: Verify the exact plugin name including tags if applicable.
    • Network or authentication errors: Confirm that the API URL and credentials are correctly set up in n8n.
  • Error messages:

    • Authentication failures usually indicate invalid or expired API tokens.
    • "Endpoint not found" errors suggest the selected endpoint ID does not exist or is unreachable.
    • Plugin not found errors occur if the specified plugin name does not match any plugin on the endpoint.

Resolving these typically involves verifying credentials, endpoint availability, and plugin naming.

Links and References

Discussion