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 Docker and edge computing resources. Specifically, for the Edge Group - Delete operation, it allows users to delete an existing edge group by its ID. Edge groups in Portainer are collections of edge endpoints used to organize and manage distributed edge devices.
Typical use cases include:
- Removing obsolete or decommissioned edge groups from your Portainer environment.
- Automating cleanup of edge groups as part of infrastructure lifecycle management.
- Managing edge computing resources programmatically within workflows.
Example: You have an edge group representing a set of IoT devices at a location that is no longer active. Using this node operation, you can delete that group automatically when triggered.
Properties
| Name | Meaning |
|---|---|
| Force Delete | Whether to force deletion even if the edge group resource is currently in use (boolean). |
| Edge Group ID | The unique identifier of the edge group to be deleted (string, required). |
Output
The node outputs the JSON response returned by the Portainer API after attempting to delete the specified edge group. Typically, this will be an empty object or confirmation of deletion. No binary data output is involved.
The output JSON structure depends on the API response but generally confirms success or provides error details if deletion failed.
Dependencies
- Requires a valid Portainer API key credential configured in n8n.
- Needs the base URL of the Portainer instance to send API requests.
- The node uses HTTP DELETE method to
/edge_groups/{edgeGroupId}endpoint of the Portainer API.
Troubleshooting
Common issues:
- Invalid or missing Edge Group ID will cause the API to reject the request.
- Insufficient permissions or invalid API key may result in authorization errors.
- Trying to delete an edge group that is currently in use without setting "Force Delete" may fail.
Error messages:
- 404 Not Found: The specified edge group ID does not exist.
- 401 Unauthorized: API key is invalid or lacks permission.
- 409 Conflict: The edge group is in use; try enabling "Force Delete" to override.
Resolutions:
- Verify the Edge Group ID is correct.
- Ensure the API key has sufficient privileges.
- Use the "Force Delete" option cautiously to remove groups still in use.