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 images on a selected endpoint. The "Image Inspect" operation fetches detailed information about a specified Docker image by its name or ID. This is useful for scenarios where you need to retrieve metadata, configuration details, or manifests of Docker images managed via Portainer.

Practical examples include:

  • Auditing image details before deployment.
  • Automating checks on image versions or configurations.
  • Integrating image inspection into CI/CD pipelines to verify image integrity.

Properties

Name Meaning
EndpointID Name or ID Select or specify the Portainer endpoint (server) where the Docker image resides.
Name The Docker image name or ID to inspect.
Additional Fields Optional extra parameters; currently supports: Manifests - whether to include manifests in the response.

The Additional Fields property includes:

  • Manifests: A boolean option to include image manifests in the returned summary.

Output

The node outputs JSON data containing detailed information about the inspected Docker image. This includes metadata such as image ID, tags, creation date, size, and optionally manifests if requested. The output structure directly reflects the response from the Portainer API's image inspection endpoint.

No binary data output is produced by this node.

Dependencies

  • Requires access to a Portainer instance with the Docker environment configured.
  • Needs an API key credential for authenticating requests to the Portainer API.
  • The node depends on the Portainer API being accessible at the URL provided in credentials.
  • Uses the Portainer API endpoint /api/endpoints/{endpointId}/docker to perform operations.

Troubleshooting

  • Common issues:

    • Incorrect or missing endpoint ID can cause failures in connecting to the Docker environment.
    • Invalid image name or ID will result in errors or empty responses.
    • Network connectivity problems between n8n and the Portainer server.
    • Insufficient permissions or invalid API credentials may lead to authentication errors.
  • Error messages:

    • 404 Not Found: The specified image does not exist on the selected endpoint.
    • 401 Unauthorized: Authentication failed due to invalid or missing API credentials.
    • 500 Internal Server Error: Possible issues with the Portainer API or Docker daemon.
  • Resolutions:

    • Verify the endpoint ID is correct and the endpoint is reachable.
    • Confirm the image name or ID exists on the Docker host.
    • Check API credentials and ensure they have sufficient permissions.
    • Ensure network connectivity and that the Portainer API is operational.

Links and References

Discussion