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 interacts with Docker through the Portainer API, specifically allowing users to list Docker configs associated with a selected endpoint. It is useful for automating Docker configuration management tasks within workflows, such as retrieving configuration details for containers or services managed by Portainer.
A practical example would be fetching all Docker configs filtered by specific criteria (like config ID or name) to dynamically adjust container deployments or monitor configuration changes.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | Selects the Docker endpoint (Portainer environment) to target. You can choose from a dropdown list of available endpoints or specify an ID via expression. This determines which Docker instance the node will interact with. |
| Additional Fields | Optional extra parameters to refine the request. |
| └─ Filters | A JSON string representing filters to apply when listing configs. Supported filters include: id=<config id>, label=<key> or label=<key>=value, name=<config name>, and names=<config name>. These help narrow down the returned configs. |
Output
The node outputs JSON data containing the list of Docker configs retrieved from the specified endpoint. Each item in the output array represents a Docker config object with its properties as returned by the Portainer API.
No binary data output is produced by this node.
Dependencies
- Requires access to a Portainer API endpoint.
- Needs an API authentication token configured in n8n credentials to authorize requests to the Portainer API.
- The node uses the Portainer API base URL and endpoint ID to construct requests.
Troubleshooting
Common issues:
- Incorrect or missing endpoint ID may cause failures in connecting to the Docker environment.
- Invalid or expired API credentials will result in authorization errors.
- Malformed JSON in the Filters field can cause query parsing errors on the API side.
Error messages:
- Authorization errors typically indicate invalid or missing API tokens; verify credential setup.
- "Not Found" errors may mean the specified endpoint does not exist or is unreachable.
- JSON parsing errors suggest that the Filters input is not properly formatted JSON; ensure correct syntax.