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 create a Docker plugin on a specified Docker endpoint managed via the Portainer API. It is useful for automating the deployment and management of Docker plugins in environments where Portainer is used as the container management platform.
Typical use cases include:
- Automating plugin installation during CI/CD pipelines.
- Managing Docker plugins across multiple endpoints programmatically.
- Integrating Docker plugin creation into broader workflow automation.
For example, a user can specify an endpoint and provide a plugin name and tarball context to deploy a new plugin without manual intervention in the Portainer UI.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The target Docker endpoint (managed by Portainer) where the plugin will be created. Options are dynamically loaded from available endpoints. |
| Name | The name of the plugin to create. The :latest tag is optional and assumed if omitted. |
| Tar Context | Path to a tar archive containing the plugin's root filesystem and manifest. This tarball is sent as the request body. |
Output
The node outputs JSON data representing the response from the Portainer API after attempting to create the plugin. This typically includes details about the newly created plugin or error information if the creation failed.
No binary data output is indicated.
Dependencies
- Requires access to a Portainer instance with API enabled.
- Needs an API key or token credential for authenticating requests to the Portainer API.
- The node depends on the Portainer API endpoint
/api/endpoints/{endpointId}/docker/plugins/create. - The user must provide a valid path to a tarball containing the plugin files.
Troubleshooting
Common issues:
- Invalid or missing endpoint ID: Ensure the selected endpoint exists and is accessible.
- Incorrect plugin name format: Verify the plugin name follows Docker plugin naming conventions.
- Invalid tarball path or corrupted tar file: Confirm the tarball contains the correct plugin structure.
- Authentication failures: Check that the API key/token is valid and has sufficient permissions.
Error messages:
- HTTP 401 Unauthorized: Indicates invalid or missing authentication credentials.
- HTTP 404 Not Found: The specified endpoint ID does not exist.
- HTTP 400 Bad Request: Usually caused by malformed plugin name or invalid tarball content.
Resolving these errors involves verifying credentials, endpoint availability, and input correctness.