PortainerInstall

Overview

This node allows updating an existing environment endpoint in Portainer by specifying its identifier and the new details. It is useful for automating the management of environment endpoints, such as modifying connection settings or metadata without manual intervention through the Portainer UI.

Practical examples include:

• Updating endpoint configurations during deployment pipelines.
• Automating environment updates when infrastructure changes.
• Integrating with other systems to keep endpoint data synchronized.

Properties

Output

The node outputs the response from the Portainer API after attempting to update the specified endpoint. The output is a JSON object representing the updated environment endpoint details as returned by the API.

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 configured in the credentials.
• The node uses HTTP requests with JSON payloads to communicate with the Portainer API.

Troubleshooting

• Invalid Id: If the provided Id does not correspond to an existing endpoint, the API will likely return an error indicating the resource was not found. Verify the Id before running the node.
• Malformed Body: The Body property must be a valid JSON string representing the endpoint details. Invalid JSON will cause request failures.
• Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update endpoints.
• Network Issues: Connectivity problems to the Portainer server will result in request timeouts or errors.
• API Version Mismatch: If the Portainer API version differs significantly, some fields in the Body may be unsupported or behave differently.

Links and References

• Portainer API Documentation
• Portainer Official Website