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 → Delete
AI-generatedOverview
This node operation deletes an edge computing group in Portainer. It is useful for managing edge computing resources by removing groups that are no longer needed or relevant. For example, if an edge group is deprecated or replaced, this operation can be used to clean up the environment by deleting that group.
Use Case Examples
- Deleting an edge group that is no longer in use to free up resources.
- Removing a dynamic or static edge group after restructuring edge endpoints.
Properties
| Name | Meaning |
|---|---|
| Force Delete | Whether to force deletion even if the edge group resource is currently in use. |
| Edge Group ID | The unique identifier of the edge computing group to be deleted. |
| Request Options | Additional HTTP request options such as batching, SSL validation, proxy, and timeout settings. |
Output
JSON
response- The response from the Portainer API after attempting to delete the edge group.
Dependencies
- Portainer API
- API key credential for authentication
Troubleshooting
- If the edge group is in use and forceDelete is false, the deletion may fail with an error indicating the resource is in use. Set forceDelete to true to override.
- Network or SSL issues may cause request failures; verify proxy and SSL settings in Request Options.
- Ensure the Edge Group ID is correct and exists; otherwise, the API will return a not found error.
Links
- Portainer API - Delete Edge Group - Official Portainer API documentation for deleting edge groups.