Actions72
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
Overview
This node integrates with the Portainer API to manage Docker resources programmatically. Specifically, for the Image resource with the Get Many operation, it retrieves a list of Docker images available in a specified Docker environment managed by Portainer.
Common scenarios where this node is beneficial include:
- Automating the retrieval of all Docker images from a specific environment for inventory or auditing purposes.
- Integrating image listings into CI/CD pipelines to verify available images before deployment.
- Monitoring and managing Docker images across multiple environments via workflows.
Example use case:
- A DevOps engineer wants to fetch all Docker images from a particular Docker endpoint to check which images are currently stored and decide which ones to clean up or update.
Properties
| Name | Meaning |
|---|---|
| Environment ID | The ID of the Portainer environment/endpoint where the Docker images reside. This identifies the target Docker environment to query. |
Output
The node outputs JSON data representing the list of Docker images retrieved from the specified environment. The structure corresponds to the Portainer API response for listing images, typically an array of image objects containing details such as image IDs, tags, creation dates, sizes, and other metadata.
No binary data output is involved in this operation.
Dependencies
- Requires connection to a Portainer instance with API access.
- Needs an API key credential configured in n8n to authenticate requests to the Portainer API.
- The base URL of the Portainer API must be set in the credentials.
- The node uses HTTP GET requests to the Portainer API endpoint
/endpoints/{environmentId}/docker/images/jsonto retrieve images.
Troubleshooting
Common issues:
- Invalid or missing Environment ID: Ensure the Environment ID corresponds to a valid Portainer endpoint.
- Authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Network connectivity: Confirm that n8n can reach the Portainer API URL.
- Empty results: If no images are returned, check if the environment actually contains any Docker images.
Error messages:
- Unauthorized (401): Indicates invalid API key or insufficient permissions. Recheck credentials.
- Not Found (404): Possibly incorrect Environment ID or Portainer API URL.
- Connection timeout or network errors: Check network settings and Portainer availability.
Links and References
- Portainer API Documentation
- Docker Images API Reference (Portainer proxies Docker API)
- n8n Documentation on Credentials
This summary focuses on the "Image" resource with the "Get Many" operation, describing how the node fetches Docker images from a specified Portainer environment using the provided Environment ID property.