Portainer icon

Portainer

Trabalhe com dados da API do Portainer para gerenciar Docker

Overview

This node integrates with the Portainer API to manage Docker registries. Specifically, the Update Registry operation allows users to update an existing Docker image registry's details such as its name, URL, and optional authentication credentials (username and password). This is useful for maintaining or correcting registry configurations without needing to delete and recreate them.

Common scenarios include:

  • Changing the URL of a private Docker registry.
  • Updating credentials when passwords or usernames change.
  • Renaming a registry for clarity or organizational purposes.

Example: You have a private Docker registry whose URL has changed due to infrastructure updates. Using this node, you can update the registry URL and credentials seamlessly within your automation workflows.

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 node outputs the JSON response from 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 registry.

No binary data output is involved in this operation.

Dependencies

  • Requires a valid connection to a Portainer instance via an API key credential.
  • The node uses the Portainer API endpoint /registries/{registryId} with HTTP PUT method.
  • The base URL and API key must be configured in the node credentials.

Troubleshooting

  • Invalid Registry ID: If the provided Registry ID does not exist, the API will return an error indicating the resource was not found. Verify the Registry ID is correct.
  • Authentication Errors: If the API key credential is invalid or lacks permissions, the request will fail with an authorization error. Ensure the API key has sufficient rights.
  • Malformed URL or Missing Required Fields: The registry name and URL are required. Omitting these or providing invalid URLs may cause validation errors.
  • Empty Credentials: Username and password are optional but if provided, ensure they are correct; otherwise, authentication to the registry may fail downstream.

Links and References


This summary is based on static analysis of the node's configuration and routing definitions for the "Registry" resource and "Update" operation.

Discussion