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 disable a Docker plugin on a selected endpoint. It is useful in scenarios where you manage containerized environments via Portainer and need to programmatically disable plugins that are no longer required or causing issues.
For example, if you have a plugin enabled on a Docker endpoint that you want to deactivate without manually accessing the Portainer UI, this node can automate that process. It supports forcing the disable action even if the plugin is currently in use.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Docker endpoint where the plugin resides. You can select from a list or specify an ID using an expression. |
| Name | The name of the plugin to disable. The :latest tag is optional and assumed if omitted. |
| Force | (Optional) Whether to force disable the plugin even if it is still in use. Defaults to true. |
Output
The node outputs JSON data representing the response from the Portainer API after attempting to disable the specified plugin. This typically includes status information about the operation's success or failure.
No binary data output is involved.
Dependencies
- Requires access to a Portainer instance with the Docker environment managed.
- Needs an API key credential for authenticating requests to the Portainer API.
- The node uses the Portainer API endpoint
/api/endpoints/{endpointId}/docker/plugins/{pluginName}/disablewith optional query parameterforce.
Troubleshooting
Common Issues:
- Incorrect or missing endpoint ID may cause the request to fail.
- Specifying a plugin name that does not exist on the endpoint will result in an error.
- Lack of sufficient permissions or invalid API credentials will prevent successful disabling.
Error Messages:
- "Plugin not found" — Verify the plugin name and ensure it exists on the selected endpoint.
- "Unauthorized" or "Forbidden" — Check API credentials and user permissions.
- "Endpoint not found" — Confirm the endpoint ID is correct and accessible.
To resolve these, double-check input values, ensure the API key has proper rights, and verify network connectivity to the Portainer server.