Portainer icon

Portainer

Interact with Portainer via API

Actions190

Teams → Team Delete

AI-generated

Overview

This node operation deletes a team in the Portainer system by specifying the team's unique identifier. It is useful for managing user groups or teams within Portainer, especially when cleaning up unused or obsolete teams to maintain an organized environment.

Practical examples include:

  • Removing a team that is no longer active.
  • Automating cleanup of test or temporary teams after project completion.
  • Managing team lifecycle as part of infrastructure automation workflows.

Properties

Name Meaning
Id The unique numeric identifier of the team to delete. This is required to specify which team should be removed.

Output

The output JSON typically contains the response from the Portainer API confirming the deletion of the specified team. This may include status information or confirmation messages indicating success or failure of the delete operation.

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The node expects the base URL of the Portainer instance to be configured in the credentials.
  • The Portainer API must be accessible and the authenticated user must have permissions to delete teams.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent team ID will result in an error.
    • Insufficient permissions for the API token can cause authorization failures.
    • Network connectivity issues to the Portainer API endpoint will prevent execution.
  • Error messages and resolutions:

    • "Team not found" — Verify the team ID is correct and exists.
    • "Unauthorized" or "Forbidden" — Check API credentials and ensure they have delete permissions.
    • "Network Error" — Confirm the Portainer URL is reachable and correct in credentials.

Links and References

Discussion