Portainer icon

Portainer

Interact with Portainer via API

Actions190

Endpoint Groups → Endpoint Group Update

AI-generated

Overview

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

Practical examples include:

  • Renaming an Endpoint Group to better reflect its purpose.
  • Updating group settings after infrastructure changes.
  • Automating bulk updates to multiple Endpoint Groups via workflows.

Properties

Name Meaning
Id The unique identifier of the Endpoint Group to update. This is a required numeric value.
Body The JSON string containing the updated details of the Endpoint Group. This should include all fields that need to be changed and must be formatted as a valid JSON string.

Output

The node outputs the response from the Portainer API after attempting to update the Endpoint Group. The json output field typically contains the updated Endpoint Group object reflecting the new state after the update operation.

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

  • Invalid Id: If the provided Endpoint Group ID does not exist, the API will return an error indicating the resource was not found. Verify the ID before running the node.
  • Malformed Body: The Body property must be a valid JSON string. Errors will occur if the JSON is invalid or missing required fields. Use JSON validators to ensure correctness.
  • Authentication Errors: If the API key or credentials are incorrect or expired, the node will fail with authorization errors. Check and update credentials as needed.
  • API Connectivity Issues: Network problems or incorrect base URL configurations can cause request failures. Confirm connectivity and correct URL settings.

Links and References

Discussion