Actions72
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
Overview
This node integrates with the Portainer API to manage edge computing groups ("Edge Groups"). Specifically, the Update operation for the Edge Group resource allows users to modify an existing edge group’s properties such as its name, whether it is dynamic (based on tags), and the associated tags or endpoints.
Typical use cases include:
- Renaming an existing edge group to better reflect its purpose.
- Changing a static edge group to a dynamic one by enabling tag-based membership.
- Updating the list of tags or endpoints that define the group membership.
For example, you might update an edge group to add new tags so that devices automatically join the group based on those tags, or switch from a static list of endpoints to a dynamic tag-based group.
Properties
| Name | Meaning |
|---|---|
| Edge Group ID | The unique identifier of the edge group to update. |
| Edge Group Name | The new name for the edge group. |
| Is Dynamic | Boolean flag indicating if the group is dynamic (membership based on tags) or static. |
| Tag IDs | Comma-separated list of tag IDs used to define membership for a dynamic group. |
| Endpoint IDs | Comma-separated list of endpoint IDs included in a static group. |
Output
The node outputs the JSON response returned by the Portainer API after updating the edge group. This typically includes the updated edge group object with its current properties such as ID, name, dynamic status, associated tags, and endpoints.
No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating with the Portainer API.
- The base URL of the Portainer instance must be configured in the credentials.
- The node sends HTTP PUT requests to the
/edge_groups/{edgeGroupId}endpoint of the Portainer API.
Troubleshooting
- Invalid Edge Group ID: If the provided Edge Group ID does not exist, the API will return an error. Verify the ID is correct.
- Malformed Tag or Endpoint IDs: Tag IDs and Endpoint IDs must be comma-separated integers. Incorrect formatting may cause request failure.
- Permission Denied: Ensure the API key has sufficient permissions to update edge groups.
- Dynamic vs Static Conflict: When
Is Dynamicis true, onlyTag IDsshould be provided; when false, onlyEndpoint IDsshould be provided. Mixing these incorrectly may cause unexpected behavior. - Empty Required Fields:
Edge Group NameandEdge Group IDare required. Omitting them will result in validation errors.