Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Overview

This node allows users to interact with Docker through the Portainer API, specifically enabling the pushing of Docker plugins to a specified Docker endpoint managed by Portainer. It is useful in scenarios where automated deployment or management of Docker plugins is required within containerized environments managed via Portainer. For example, a DevOps engineer can use this node to push updated versions of Docker plugins to different endpoints as part of a CI/CD pipeline.

Properties

Name Meaning
EndpointID Name or ID The identifier of the Docker endpoint managed by Portainer where the plugin will be pushed. Users can select from a list of available endpoints or specify an ID using an expression.
Name The name of the Docker plugin to push. The :latest tag is optional and assumed if omitted.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to push the Docker plugin. This typically includes status information about the push operation, such as success confirmation or error details. There is no indication that binary data is output by this node.

Dependencies

  • Requires access to a Portainer instance with its API enabled.
  • Needs an API authentication token or key configured in n8n credentials to authenticate requests to the Portainer API.
  • The node depends on the Portainer API endpoint /api/endpoints to retrieve available Docker endpoints.
  • The base URL for API requests is dynamically constructed from the provided credentials and selected endpoint ID.

Troubleshooting

  • Common Issues:
    • Incorrect or missing API credentials may cause authentication failures.
    • Specifying an invalid or non-existent endpoint ID will result in errors when trying to push the plugin.
    • Network connectivity issues between n8n and the Portainer server can prevent successful API calls.
  • Error Messages:
    • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
    • "Endpoint not found" errors suggest the selected endpoint ID does not exist or is inaccessible; confirm the endpoint selection.
    • API request timeouts or connection refused errors point to network or server availability problems; check Portainer server status and network settings.

Links and References

Discussion