Portainer icon

Portainer

Trabalhe com dados da API do Portainer para gerenciar Docker

Overview

This node integrates with the Portainer API to manage Docker-related resources, specifically here focusing on the Team resource's Update operation. It allows users to update an existing team by specifying its ID and a new name.

Typical use cases include:

  • Renaming a team in your Portainer-managed Docker environment.
  • Modifying team details as part of automated workflows for user and permission management.
  • Keeping team information up-to-date without manual intervention in the Portainer UI.

For example, you might use this node to rename a team from "Developers" to "DevOps" automatically when organizational changes occur.

Properties

Name Meaning
Team ID The unique identifier of the team to update. This is required to specify which team will be modified.
Team Name The new name to assign to the team. This is a required string representing the updated team name.

Output

The node outputs the JSON response returned by the Portainer API after updating the team. This typically includes the updated team object with its properties such as ID, name, and possibly other metadata managed by Portainer.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to a Portainer instance via its REST API.
  • Needs an API key credential configured in n8n to authenticate requests to Portainer.
  • The base URL of the Portainer API must be set in the credentials.
  • The node uses HTTP PUT method to send the update request to /api/teams/{teamId} endpoint.

Troubleshooting

  • Invalid Team ID: If the provided Team ID does not exist or is incorrect, the API will return an error indicating the team was not found. Verify the Team ID before running the node.
  • Authentication Errors: Missing or invalid API key will cause authentication failures. Ensure the API key credential is correctly configured and has sufficient permissions.
  • Network Issues: Connectivity problems to the Portainer server will result in request timeouts or connection errors. Check network access and Portainer availability.
  • Validation Errors: Providing an empty or invalid team name may cause the API to reject the update. Make sure the team name is a valid non-empty string.

Links and References


This summary is based on static analysis of the node's configuration and routing definitions for the Team Update operation within the Portainer integration.

Discussion