Portainer icon

Portainer

Trabalhe com dados da API do Portainer para gerenciar Docker

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. Edge groups in Portainer are used to organize and manage sets of edge endpoints (devices or environments running at the network edge).

Typical use cases include:

  • Fetching configuration and status details of an existing edge group.
  • Automating monitoring or reporting workflows that require up-to-date edge group data.
  • Integrating edge group information into broader infrastructure management pipelines.

Example: You want to retrieve the properties of an edge group identified by a given ID to verify its configuration or to display its details in a dashboard.

Properties

Name Meaning
Edge Group ID The unique identifier of the edge group you want to retrieve. This is required to specify which edge group to get details for.

Output

The node outputs JSON data representing the full details of the requested edge group as returned by the Portainer API. This typically includes fields such as the group's name, whether it is dynamic, associated tag IDs (for dynamic groups), and endpoint IDs (for static groups). The exact structure depends on the Portainer API response for the /edge_groups/{id} GET endpoint.

No binary data output is involved in this operation.

Dependencies

  • Requires a valid connection to a Portainer instance via its API.
  • An API key credential must be configured in n8n to authenticate requests to the Portainer API.
  • 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 provided and correctly references 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 or connectivity issues: Confirm that the Portainer API endpoint is reachable from the n8n environment.
  • Resource not found: If the specified edge group ID does not exist, the API will return a 404 error. Double-check the ID value.
  • API rate limits or server errors: Handle HTTP 429 or 5xx responses by retrying after some delay or checking Portainer server health.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion