PortainerInstall

Overview

This node interacts with the Portainer API to inspect the edge status of a specific environment endpoint. It is useful for monitoring and managing the connectivity or health status of endpoints managed by Portainer, which is a container management platform. For example, users can check if an edge agent on a remote environment is online or offline, helping in troubleshooting deployment or connectivity issues.

Properties

Output

The node outputs JSON data containing the edge status information of the specified environment endpoint. This typically includes details about the connection state, last seen time, and other relevant metadata about the edge agent's status. The output does not include binary data.

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 the Portainer REST API endpoint /api as its base path.

Troubleshooting

• Common issue: Invalid or missing environment ID will cause the API call to fail. Ensure the "Id" property is correctly set to a valid environment identifier.
• Authentication errors: If the API key or URL is incorrect or expired, the node will fail to connect. Verify the API credentials and Portainer URL.
• Network issues: Connectivity problems between n8n and the Portainer server may result in timeouts or unreachable errors.
• Error messages: Typically include HTTP error codes like 401 Unauthorized (authentication failure), 404 Not Found (invalid environment ID), or 500 Internal Server Error (server-side issues). Check credentials and input parameters accordingly.

Links and References

• Portainer API Documentation
• Portainer Edge Agent Overview