Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Distribution → Distribution Inspect

AI-generated

Overview

This node interacts with Docker through the Portainer API, specifically focusing on the "Distribution Inspect" operation under the "Distribution" resource. It allows users to inspect a Docker image's distribution details by specifying an endpoint and the image name or ID. This is useful for scenarios where you need to retrieve metadata or detailed information about a Docker image hosted on a specific Docker endpoint managed by Portainer.

Practical examples include:

  • Retrieving detailed information about a Docker image before deployment.
  • Auditing or verifying image metadata in automated CI/CD pipelines.
  • Integrating Docker image inspection into broader workflows that manage container deployments.

Properties

Name Meaning
EndpointID Name or ID The Docker endpoint to connect to via the Portainer API. You can select from a list of available endpoints or specify an ID using an expression.
Name The name or ID of the Docker image whose distribution details you want to inspect.

Output

The node outputs JSON data containing the detailed distribution information of the specified Docker image as returned by the Portainer API. This typically includes metadata such as image layers, digests, tags, and other relevant distribution details.

If the node supports binary data output (not explicitly shown here), it would represent any binary content related to the Docker image, but based on the provided code and properties, the primary output is structured JSON.

Dependencies

  • Requires access to a Portainer instance with its API enabled.
  • Needs an API key or token credential configured in n8n 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 selected endpoint exists and is accessible.
    • Incorrect image name or ID: Verify the image identifier is correct and available on the specified endpoint.
    • Authentication errors: Confirm that the API credentials are valid and have sufficient permissions.
    • Network connectivity problems between n8n and the Portainer server.
  • Error messages:

    • Authorization failures usually indicate invalid or expired API credentials.
    • "Endpoint not found" errors suggest the endpoint ID does not exist or is unreachable.
    • "Image not found" indicates the specified image name or ID does not exist on the endpoint.

Resolving these typically involves checking credentials, endpoint availability, and input correctness.

Links and References

Discussion