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 enabling users to pull Docker plugins on a selected Docker endpoint managed by Portainer. It is useful in scenarios where you want to programmatically manage Docker plugins across multiple Docker environments via Portainer, such as automating plugin installation or updates.
For example, you can use this node to pull a specific Docker plugin from a remote registry onto a targeted Docker endpoint, optionally specifying authentication details and custom local plugin names.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The Docker endpoint (managed by Portainer) where the plugin will be pulled. You can select from a list of available endpoints or specify an ID directly. |
| Remote | The remote reference for the plugin to install, typically in the form plugin_name[:tag]. The :latest tag is assumed if omitted. |
| Body | Optional raw body content to send with the request. |
| Additional Fields | A collection of optional fields: - Name: Local name to assign to the pulled plugin (optional, defaults to the remote plugin name). - X Registry Auth: Base64url-encoded authentication configuration for private registries. |
Output
The node outputs JSON data representing the response from the Portainer API after attempting to pull the plugin. This typically includes status information about the pull operation, such as success confirmation or error details.
No binary data output is involved.
Dependencies
- Requires access to a Portainer instance managing Docker endpoints.
- Needs an API key or token credential for authenticating with the Portainer API.
- The node dynamically loads available Docker endpoints from Portainer to populate the endpoint selection property.
Troubleshooting
- Common issues:
- Invalid or missing endpoint ID: Ensure the selected endpoint exists and is accessible.
- Authentication errors: Verify that the API key/token credential is valid and has sufficient permissions.
- Plugin not found or inaccessible: Check the remote plugin reference and registry authentication if pulling from private registries.
- Error messages:
- Authorization failures usually indicate invalid credentials or insufficient permissions.
- HTTP errors related to the endpoint may mean the endpoint is offline or unreachable.
- Malformed plugin references or authentication headers can cause request rejections.