Actions88
- 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
- Network Actions
- Volume Actions
- Swarm Actions
- Node Actions
- Secret Actions
- System Actions
- Exec Actions
- Service Actions
- Task Actions
Overview
This node allows users to push Docker images to a remote registry via the Portainer API. It is useful in scenarios where you manage container images locally and want to upload them to a registry for deployment or sharing. For example, after building a Docker image on a local machine or CI pipeline, you can use this node to push that image to a private or public Docker registry.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Portainer endpoint to use for accessing the Docker environment. You can select from a list of available endpoints or specify an ID using an expression. This determines which Docker host the image push command will be executed against. |
| Name | The name of the Docker image to push, e.g., registry.example.com/myimage. The image must exist locally with this name. If a tag is included here, it is ignored; use the "Tag" property instead to specify the tag. |
| X Registry Auth | A base64url-encoded authentication configuration required by the Docker registry to authorize the push operation. This typically includes credentials like username and password encoded in a specific format. |
| Additional Fields | Optional extra parameters: - Tag: The tag of the image to push (e.g., latest). If omitted, all tags of the image present locally are pushed.- Platform: JSON string specifying the OCI platform variant to push (e.g., {"os": "linux", "architecture": "arm", "variant": "v5"}). If not provided, all variants are pushed if available. |
Output
The node outputs JSON data representing the response from the Portainer API after attempting to push the image. This typically includes status information about the push operation, such as success confirmation or error details. There is no indication that binary data is output by this node.
Dependencies
- Requires access to a Portainer API endpoint configured with appropriate permissions.
- Requires an API key or token credential for authenticating with the Portainer API.
- The Docker image to be pushed must already exist in the local image store of the targeted Docker endpoint.
- The user must provide a valid base64url-encoded registry authentication string for pushing to the Docker registry.
Troubleshooting
- Common issues:
- Incorrect or missing
endpointIdmay cause failure to connect to the Docker host. - Providing an invalid or expired registry authentication token (
X Registry Auth) will result in authorization errors. - Specifying an image name that does not exist locally on the Docker endpoint will cause the push to fail.
- Using an unsupported or incorrect platform JSON string may cause errors if the image does not have the specified variant.
- Incorrect or missing
- Error messages:
- Authentication failures usually indicate problems with the
X Registry Authheader; verify encoding and credentials. - "Image not found" errors suggest the image name/tag combination is not present locally.
- API connection errors may indicate network issues or incorrect endpoint configuration.
- Authentication failures usually indicate problems with the