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-related resources, specifically here focusing on the Team resource with the Delete operation. It allows users to delete a team by specifying its unique Team ID.
Common scenarios where this node is beneficial include:
- Automating cleanup of teams that are no longer needed in your Docker environment managed via Portainer.
- Integrating team management into broader workflows for user and permission administration.
- Ensuring consistent removal of teams as part of deprovisioning or organizational changes.
Practical example:
- You have an automated process that removes project-specific teams after project completion. This node can be used to delete those teams programmatically by providing their Team IDs.
Properties
| Name | Meaning |
|---|---|
| Team ID | The unique identifier of the team to delete. |
| Force Delete | Whether to force deletion even if the team resource is currently in use (true/false). |
Output
The node outputs the JSON response from the Portainer API after attempting to delete the specified team. Typically, this will be an empty object or confirmation of deletion if successful.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to a Portainer instance via its API.
- Requires an API key credential configured in n8n to authenticate requests to the Portainer API.
- The base URL of the Portainer API must be set in the credentials.
Troubleshooting
Common issues:
- Invalid or missing Team ID: The API will reject requests without a valid team identifier.
- Insufficient permissions: The API key used must have rights to delete teams.
- Team in use: If the team is assigned to resources and
Force Deleteis false, deletion may fail.
Error messages:
- 404 Not Found: The specified Team ID does not exist.
- 403 Forbidden: The API key lacks permission to delete teams.
- 409 Conflict: The team cannot be deleted because it is in use; try enabling
Force Delete.
Resolutions:
- Verify the Team ID is correct.
- Ensure the API key has appropriate permissions.
- Use the
Force Deleteoption cautiously to override usage restrictions.
Links and References
- Portainer API Documentation
- Portainer Teams Management (for detailed API endpoints and behavior)