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 perform image searches on a Docker environment via the Portainer API. It is useful for scenarios where you want to find Docker images based on search terms and optional filters such as official status or star ratings. For example, you might use this node to search for popular or official Docker images before deploying containers.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | Select or specify the Portainer endpoint ID to access the Docker API. |
| Term | The search term used to query Docker images. |
| Additional Fields | Optional parameters to refine the search: |
| - Limit | Maximum number of results to return. |
| - Filters | JSON encoded filters to apply on the image list, e.g., `is-official=(true |
Output
The node outputs JSON data containing the list of Docker images matching the search criteria. Each item in the output corresponds to an image with its associated metadata as returned by the Portainer API. There is no binary data output.
Dependencies
- Requires connection to a Portainer API instance.
- Needs an API key credential configured in n8n to authenticate requests to the Portainer API.
- The user must specify a valid Portainer endpoint ID to target the correct Docker environment.
Troubleshooting
- Invalid Endpoint ID: If the specified endpoint ID does not exist or is inaccessible, the node will fail. Verify the endpoint ID is correct and accessible.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access the Portainer API.
- Malformed Filters: Filters must be valid JSON strings following the expected format. Invalid JSON or unsupported filter keys may cause errors.
- Empty Results: If no images match the search term or filters, the output will be empty. Try broadening the search term or removing filters.