Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Groups → Edge Group Inspect

AI-generated

Overview

This node allows you to inspect a specific Edge Group within the Portainer platform by providing its unique identifier. It is useful for retrieving detailed information about an Edge Group, such as its configuration and status, which can help in managing and monitoring edge devices effectively. For example, you might use this node to fetch details of an Edge Group before performing updates or audits.

Properties

Name Meaning
Id The unique numeric identifier of the Edge Group to inspect

Output

The node outputs JSON data containing detailed information about the specified Edge Group. This typically includes properties such as the group's name, ID, associated endpoints, and other configuration details relevant to the Edge Group's state and setup.

Dependencies

  • Requires an API key credential to authenticate with the Portainer API.
  • The node expects the base URL of the Portainer instance to be configured in the credentials.
  • The Portainer API must be accessible from the n8n environment where the node runs.

Troubleshooting

  • Invalid or missing Id: Ensure that the "Id" property is provided and corresponds to an existing Edge Group in Portainer.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to access Edge Group information.
  • Network issues: Confirm that the Portainer API endpoint is reachable from your n8n instance.
  • Unexpected API responses: Check if the Portainer API version matches the expected version supported by the node.

Links and References

Discussion