Actions86
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Environment Actions
- Image Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Setting Actions
- Stack Actions
- System Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Edge Group → Update
AI-generatedOverview
This node operation updates an existing edge computing group in Portainer. It allows users to modify the group's name, whether it is dynamic (tag-based), and the associated tag IDs or endpoint IDs depending on the group's type. This operation is useful for managing and organizing edge computing resources dynamically or statically within a Portainer environment.
Use Case Examples
- Updating the name of an edge group to better reflect its purpose.
- Changing an edge group from static to dynamic by setting the 'Is Dynamic' flag and providing relevant tag IDs.
- Modifying the list of endpoints associated with a static edge group.
Properties
| Name | Meaning |
|---|---|
| Edge Group ID | The unique identifier of the edge computing group to update. |
| Edge Group Name | The new name for the edge computing group. |
| Is Dynamic | Flag indicating whether the group is dynamic (tag-based) or static. |
| Tag IDs | Comma-separated list of tag IDs used to define the dynamic group membership. Only applicable if 'Is Dynamic' is true. |
| Endpoint IDs | Comma-separated list of endpoint IDs used to define the static group membership. Only applicable if 'Is Dynamic' is false. |
| Request Options | Additional HTTP request options such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
body- The JSON response body from the Portainer API after updating the edge group, containing details of the updated group.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the 'Edge Group ID' is correct and the group exists in Portainer to avoid 'not found' errors.
- Verify that the 'Tag IDs' or 'Endpoint IDs' are correctly formatted as comma-separated integers depending on the 'Is Dynamic' flag.
- Check network connectivity and proxy settings if requests fail or time out.
- If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option cautiously.
Links
- Portainer Edge Groups API Documentation - Official API documentation for managing edge groups in Portainer, including update operations.