Actions107
- Node Actions
- Network Actions
- Container Actions
- Container List
- Container Create
- Container Inspect
- Container Top
- Container Logs
- Container Changes
- Container Export
- Container Stats
- Container Resize
- Container Start
- Container Stop
- Container Restart
- Container Kill
- Container Update
- Container Rename
- Container Pause
- Container Unpause
- Container Attach
- Container Attach Websocket
- Container Wait
- Container Delete
- Container Archive Info
- Container Archive
- Put Container Archive
- Container Prune
- Image Actions
- Volume Actions
- Swarm Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
- Config Actions
- Plugin Actions
- Distribution Actions
- Session Actions
Overview
This node allows users to interact with Docker images through the Portainer API. Specifically, the "Image List" operation fetches a list of Docker images from a specified Docker endpoint managed by Portainer. This is useful for scenarios where you want to automate container management tasks such as auditing available images, cleaning up unused images, or integrating image data into other workflows.
Practical examples include:
- Automatically retrieving all Docker images on a server to generate reports.
- Filtering images based on labels or creation time to identify candidates for cleanup.
- Integrating image metadata into deployment pipelines or monitoring dashboards.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Docker endpoint managed by Portainer to query. You can select from a list of available endpoints or specify an ID via expression. This tells the node which Docker environment to target. |
| Additional Fields | Optional parameters to customize the image listing: - All: Show all images including intermediate layers (default shows only final layer images). - Filters: JSON string to filter images by criteria such as before, dangling, label, reference, since, and until.- Shared Size: Include shared size info in results. - Digests: Include digest information. - Manifests: Include manifests summary. |
Output
The node outputs a JSON array where each element represents a Docker image object retrieved from the Portainer-managed Docker endpoint. Each image object contains standard Docker image metadata fields such as ID, repository tags, creation date, size, and optionally additional fields like shared size, digests, and manifests depending on the input options.
If binary data were involved (e.g., image tarballs), it would be indicated here, but this operation only returns JSON metadata about images.
Dependencies
- Requires access to a Portainer API instance managing one or more Docker endpoints.
- Requires an API key credential or token configured in n8n to authenticate against the Portainer API.
- The node uses the Portainer API base URL and endpoint ID to construct requests.
- No other external dependencies are needed beyond the Portainer API and its authentication.
Troubleshooting
Common issues:
- Invalid or missing endpoint ID: Ensure the selected endpoint exists and is accessible.
- Authentication errors: Verify that the API key/token credentials are correct and have sufficient permissions.
- Malformed filters JSON: Filters must be valid JSON strings matching the expected format; invalid JSON will cause request failures.
- Network connectivity problems between n8n and the Portainer API.
Error messages:
- Unauthorized or 401 errors indicate credential issues.
- 404 errors may mean the endpoint ID does not exist.
- 400 errors often relate to invalid query parameters such as malformed filters.
Resolving these typically involves checking credentials, endpoint configuration, and input parameter formatting.