Portainer icon

Portainer

Interact with Portainer via API

Actions190

Registries → Registry Configure

AI-generated

Overview

This node interacts with a Portainer API to configure a specific registry. It allows users to update or set the configuration of a container registry managed by Portainer by specifying the registry's identifier and providing the configuration details in JSON format.

Common scenarios include automating the management of container registries within Portainer, such as updating credentials, changing registry settings, or integrating registry configuration into CI/CD pipelines.

For example, a user might use this node to programmatically update the authentication details of a private Docker registry used by their container deployments.

Properties

Name Meaning
Id The unique identifier of the registry to configure. This is a required numeric value that specifies which registry will be updated.
Body The registry configuration data in JSON string format. This contains the new settings or updates to apply to the specified registry.

Output

The node outputs JSON data representing the response from the Portainer API after attempting to configure the registry. This typically includes confirmation of the updated registry details or error information if the operation failed.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node expects the base URL of the Portainer instance to be provided via credentials.
  • The Portainer API must be accessible from the n8n environment where this node runs.

Troubleshooting

  • Invalid Registry Id: If the provided registry ID does not exist, the API will likely return an error. Verify the ID corresponds to an existing registry.
  • Malformed JSON in Body: The body property must be valid JSON. Invalid JSON will cause the request to fail.
  • Authentication Errors: Ensure the API key credential is correct and has sufficient permissions to modify registries.
  • Network Issues: Confirm that the Portainer API endpoint is reachable from n8n.

Links and References

Discussion