Portainer icon

Portainer

Interact with Portainer via API

Actions190

Edge Groups → Ege Group Update

AI-generated

Overview

This node updates an existing Edge Group in Portainer by sending new data to the Portainer API. It is useful when you need to modify the configuration or metadata of a specific Edge Group, such as changing its name, tags, or other properties managed by Portainer.

Practical examples include:

  • Renaming an Edge Group to better reflect its purpose.
  • Updating labels or metadata for organizational purposes.
  • Changing settings that affect how edge devices are grouped and managed.

Properties

Name Meaning
Id The unique identifier of the Edge Group to update. This is a required numeric value.
Body The JSON string containing the updated Edge Group data. This should be a valid JSON representation of the Edge Group's new state.

Output

The node outputs the response from the Portainer API after attempting to update the Edge Group. The json output field contains the updated Edge Group object as returned by the API, reflecting the changes made.

If the API supports it, binary data is not expected in this operation since it deals with JSON data representing Edge Group configurations.

Dependencies

  • Requires an active connection to a Portainer instance via its API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The base URL of the Portainer API must be set in the node credentials.

Troubleshooting

  • Invalid Id: If the provided Edge Group Id does not exist, the API will likely return a "not found" error. Verify the Id before running the node.
  • Malformed JSON in Body: The Body property must be a valid JSON string. Invalid JSON will cause the request to fail. Use JSON validators to ensure correctness.
  • Authentication Errors: Ensure the API key/token is valid and has sufficient permissions to update Edge Groups.
  • Network Issues: Connectivity problems with the Portainer server will prevent the update. Check network access and URL correctness.

Links and References

Discussion