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 updating a Docker config object via the Portainer API. It is useful when you want to modify metadata (specifically labels) of an existing Docker config managed through Portainer without recreating or deleting it. Typical use cases include automating configuration management workflows, updating service configurations dynamically, or integrating Docker config updates into larger automation pipelines.
For example, you might use this node to update labels on a Docker config to reflect environment changes or deployment versions as part of a CI/CD process.
Properties
| Name | Meaning |
|---|---|
| EndpointID Name or ID | The identifier of the Portainer endpoint where the Docker config resides. You can select from a list of available endpoints or specify an ID using an expression. |
| Id | The ID or name of the Docker config object you want to update. |
| Version | The version number of the config object being updated. This is required to prevent conflicting writes and ensure you are updating the correct revision. |
| Body | The specification of the config to update, provided as a JSON string. Currently, only the Labels field can be changed; all other fields must remain unchanged from the original config inspect response. |
Output
The node outputs the JSON response from the Portainer API after attempting to update the Docker config. This typically includes details about the updated config object, such as its ID, version, labels, and other metadata.
No binary data output is produced by this node.
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/configs/{id}for updating configs. - The user must provide the correct endpoint ID, config ID, and version to avoid conflicts.
Troubleshooting
- Version mismatch errors: If the version number provided does not match the current version of the config in Portainer, the update will fail. Always retrieve the latest version before updating.
- Invalid body format: The
Bodyproperty must be a valid JSON string representing the config spec. Invalid JSON or unsupported fields will cause errors. - Endpoint or config not found: Ensure the endpoint ID and config ID are correct and accessible with your credentials.
- Permission issues: Make sure the API key used has sufficient permissions to update Docker configs in Portainer.
- Network or connectivity problems: Verify that the URL and network settings allow communication with the Portainer API.