Docker icon

Docker

Interact with Docker via Portainer API

Actions107

Overview

This node allows users to delete a Docker plugin via the Portainer API. It is useful in scenarios where you need to manage Docker plugins programmatically, such as automating cleanup tasks or managing plugin lifecycle in containerized environments. For example, if a plugin is no longer needed or must be replaced, this node can disable and remove it from a specified Docker endpoint.

Properties

Name Meaning
EndpointID Name or ID The identifier of the Docker endpoint where the plugin resides. You can select from a list of available endpoints or specify an ID using an expression.
Name The name of the plugin to delete. The :latest tag is optional and assumed if omitted.
Force (Optional) A boolean flag to disable the plugin before removing it. This may cause issues if the plugin is currently used by a container.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to delete the specified plugin. This typically includes status information about the deletion operation. There is no binary output.

Dependencies

  • Requires access to a Portainer API instance.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The node dynamically loads available Docker endpoints from the Portainer API to populate the endpoint selection property.

Troubleshooting

  • Common Issues:
    • Incorrect or missing endpoint ID can cause failure to locate the target Docker environment.
    • Specifying a plugin name that does not exist on the endpoint will result in an error.
    • Using the force option while the plugin is actively used by containers might lead to unexpected behavior or errors.
  • Error Messages:
    • Authorization errors indicate invalid or missing API credentials; verify your API key/token.
    • "Plugin not found" errors suggest the plugin name or tag is incorrect or the plugin is not installed on the selected endpoint.
    • Network or connection errors imply issues reaching the Portainer API URL; check network settings and base URL configuration.

Links and References

Discussion