Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Overview

This node enables interaction with Docker through the Portainer API. It is designed to manage Docker resources by sending requests to a specified Docker endpoint managed by Portainer. A common use case is automating Docker container management, image handling, or other Docker-related operations within an n8n workflow. For example, users can start, stop, or inspect containers programmatically by selecting the appropriate Docker endpoint.

Properties

Name Meaning
EndpointID Name or ID The identifier of the Docker endpoint to interact with via the Portainer API. You can select from a list of available endpoints or specify an ID using an expression.

Output

The node outputs JSON data corresponding to the response received from the Portainer API for the requested Docker operation on the selected endpoint. This typically includes details about Docker containers, images, or other Docker entities depending on the specific operation executed. The output does not include binary data.

Dependencies

  • Requires access to a Portainer instance with its API enabled.
  • Needs an API key credential for authenticating requests to the Portainer API.
  • The node configuration must include the base URL of the Portainer server and a valid endpoint ID representing the Docker environment to target.

Troubleshooting

  • Common issues:
    • Invalid or missing endpoint ID: Ensure that the selected endpoint exists and is accessible.
    • Authentication failures: Verify that the API key credential is correct and has sufficient permissions.
    • Network connectivity problems: Confirm that the n8n instance can reach the Portainer server URL.
  • Error messages:
    • "Unauthorized" or "Authentication failed": Check API credentials.
    • "Endpoint not found": Validate the endpoint ID parameter.
    • "Network error" or timeouts: Inspect network settings and Portainer server availability.

Links and References

Discussion