Portainer icon

Portainer

Interact with Portainer via API

Actions190

Registries → Registry Update

AI-generated

Overview

This node interacts with the Portainer API to update a specific registry entry. It is designed to modify existing registry details by sending updated information to the Portainer service. This operation is useful in scenarios where you need to programmatically maintain or synchronize container registries managed within Portainer, such as updating credentials, URLs, or other metadata related to a registry.

Practical examples include:

  • Automatically updating registry credentials when they rotate.
  • Changing registry URLs or names as part of infrastructure changes.
  • Integrating registry updates into CI/CD pipelines for container deployments.

Properties

Name Meaning
Id The unique identifier of the registry to update. Must be provided as a number.
Body The JSON string containing the updated registry details. This should include all necessary fields that define the registry configuration.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to update the registry. This typically includes the updated registry object or status information confirming the success or failure of the update operation.

No binary data output is involved.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in the node’s credentials to authorize requests.
  • The base URL for the Portainer API must be set in the credentials configuration.

Troubleshooting

  • Invalid Id: If the provided registry ID does not exist, the API will likely return an error indicating the resource was not found. Verify the ID before running the node.
  • Malformed Body: The body must be a valid JSON string matching the expected schema for a registry. Invalid JSON or missing required fields will cause the request to fail.
  • Authentication Errors: Ensure the API key or token is valid and has sufficient permissions to update registries.
  • Connection Issues: Network problems or incorrect base URL settings can prevent communication with the Portainer API.

Links and References

Discussion