Actions72
- Image Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Overview
This node integrates with the Portainer API to manage Docker registries. Specifically, the Update operation for the Registry resource allows users to update an existing Docker image registry's details such as its name, URL, and authentication credentials.
Typical use cases include:
- Modifying the connection details of a Docker registry when its URL or credentials change.
- Updating registry information to maintain access for automated Docker image pulls or pushes.
- Managing multiple registries in Portainer by programmatically updating their configurations.
For example, if a registry password is rotated or the registry URL changes, this node operation can be used to update those details without manually accessing the Portainer UI.
Properties
| Name | Meaning |
|---|---|
| Registry ID | The unique identifier of the registry to update. |
| Registry Name | The new or updated name of the registry. |
| Registry URL | The new or updated URL of the registry. |
| Username | (Optional) Username for authenticating with the registry. |
| Password | (Optional) Password for authenticating with the registry. |
Output
The output of this operation is the JSON response returned by the Portainer API after updating the registry. This typically includes the updated registry object with its properties such as ID, name, URL, and possibly metadata about the update status.
No binary data output is involved in this operation.
Dependencies
- Requires a valid Portainer API endpoint URL and an API key credential configured in n8n.
- The node uses HTTP PUT requests to the
/registries/{registryId}endpoint of the Portainer API. - Proper permissions on the Portainer API are necessary to update registries.
Troubleshooting
Common Issues:
- Invalid or missing
Registry IDwill cause the update to fail because the API cannot identify which registry to update. - Incorrect API credentials or insufficient permissions will result in authorization errors.
- Providing invalid URLs or malformed input fields may cause the API to reject the request.
- Invalid or missing
Error Messages:
- 404 Not Found: The specified registry ID does not exist. Verify the ID is correct.
- 401 Unauthorized: API key is invalid or lacks permission. Check API credentials.
- 400 Bad Request: Input parameters like URL or name are invalid or missing required fields. Ensure all required fields are correctly filled.
To resolve these issues, verify all input parameters, ensure the API key has sufficient rights, and confirm the Portainer instance is reachable.