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
Team → Delete
AI-generatedOverview
This node operation deletes a team in Portainer by its ID. It is useful for managing team resources within Portainer, especially when a team is no longer needed or must be removed for organizational changes. For example, an admin can delete a team that has been disbanded or merged with another team.
Use Case Examples
- Deleting a team by specifying its Team ID to remove it from Portainer.
- Force deleting a team even if it is currently in use, by enabling the force delete option.
Properties
| Name | Meaning |
|---|---|
| Team ID | The ID of the team to be deleted, required to identify which team to remove. |
| Force Delete | A boolean flag indicating whether to force deletion even if the team resource is currently in use. |
Output
JSON
body- The response body from the Portainer API after attempting to delete the team, typically indicating success or failure.
Dependencies
- Portainer API with an API key credential for authentication
Troubleshooting
- Ensure the Team ID is valid and exists in Portainer; otherwise, the deletion will fail.
- If force delete is not enabled and the team is in use, the API may reject the deletion request.
- Check API key credentials and network connectivity to Portainer API if requests fail.
Links
- Portainer Teams API Documentation - Official API documentation for managing teams in Portainer, including delete operations.