Portainer

Overview

This node integrates with the Portainer API to manage Docker and edge computing resources. Specifically, for the Edge Group - Get operation, it retrieves detailed information about a specific edge computing group by its ID. This is useful in scenarios where you need to programmatically access configuration or status details of an edge group managed within Portainer.

Practical examples include:

• Fetching metadata about an edge group before deploying or updating edge stacks.
• Auditing or monitoring edge groups as part of an automated workflow.
• Integrating edge group data into dashboards or reports.

Properties

Output

The node outputs JSON data representing the full details of the specified edge group as returned by the Portainer API. This typically includes properties such as the group's name, whether it is dynamic, associated tag IDs (for dynamic groups), and endpoint IDs (for static groups).

No binary data output is involved in this operation.

Dependencies

• Requires connection to a Portainer instance via its REST API.
• Needs an API key credential configured in n8n to authenticate requests.
• The base URL of the Portainer API must be set in the credentials.

Troubleshooting

• Invalid or missing Edge Group ID: Ensure the "Edge Group ID" property is correctly set and corresponds to an existing edge group in Portainer.
• Authentication errors: Verify that the API key credential is valid and has sufficient permissions to access edge group data.
• Network issues: Confirm that the n8n instance can reach the Portainer API endpoint.
• API version mismatch: If the Portainer API changes, some fields might differ; ensure compatibility with the API version used.

Common error messages may include HTTP 404 if the edge group ID does not exist, or HTTP 401/403 for authentication/authorization failures.

Links and References

• Portainer API Documentation
• Portainer Edge Groups (for conceptual understanding)