Actions72
- Image Actions
- Config Actions
- Container Actions
- Edge Group Actions
- Edge Stack Actions
- Network Actions
- Node Actions
- Registry Actions
- Secret Actions
- Service Actions
- Stack Actions
- Team Actions
- Template Actions
- User Actions
- Volume Actions
- Webhook Actions
Overview
This node integrates with the Portainer API to manage edge computing groups ("Edge Groups"). Specifically, the Delete operation for the Edge Group resource allows users to delete an existing edge group by its ID. This is useful in scenarios where you want to programmatically remove edge groups that are no longer needed or to clean up your edge computing environment.
Practical examples include:
- Automating cleanup of unused or obsolete edge groups.
- Integrating edge group lifecycle management into CI/CD pipelines.
- Managing edge groups dynamically based on external triggers or conditions.
Properties
| Name | Meaning |
|---|---|
| Force Delete | Whether to force deletion even if the edge group is currently in use (boolean: true/false) |
| Edge Group ID | The unique identifier of the edge group to be deleted (string, required) |
Output
The node outputs the JSON response from the Portainer API after attempting to delete the specified edge group. Typically, this will be a confirmation of successful deletion or an error message if the deletion failed.
No binary data output is involved in this operation.
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 DELETE requests to the
/edge_groups/{edgeGroupId}endpoint of the Portainer API.
Troubleshooting
Common issues:
- Attempting to delete an edge group that does not exist will result in an error.
- Deleting an edge group that is currently in use without setting "Force Delete" may fail.
- Network connectivity or authentication failures can prevent successful API calls.
Error messages and resolutions:
- 404 Not Found: The specified Edge Group ID does not exist. Verify the ID.
- 403 Forbidden or 401 Unauthorized: Authentication failed. Check API key and permissions.
- 409 Conflict: The edge group is in use and cannot be deleted unless "Force Delete" is enabled.
- Network errors: Ensure the Portainer server is reachable and the base URL is correct.