Portainer icon

Portainer

Interact with Portainer via API

Actions190

Teams → Team Update

AI-generated

Overview

This node allows updating a team in the Portainer system via its API. It is useful when you need to modify existing team details such as name, description, or other attributes managed by Portainer. For example, you might use this node to rename a team, update its permissions, or change metadata associated with it.

Properties

Name Meaning
Id The unique identifier of the team you want to update. This is a required numeric value.
Body The JSON string containing the team details to update. This should include the fields and values you want to modify for the team.

Output

The node outputs the JSON response from the Portainer API after attempting to update the team. This typically includes the updated team object or an error message if the update failed. There is no binary data output.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The base URL for the Portainer instance must be configured in the credentials.
  • The node uses HTTP requests to communicate with the Portainer API endpoint /api.

Troubleshooting

  • Invalid Team Id: If the provided team ID does not exist, the API will return an error. Verify that the team ID is correct.
  • Malformed Body: The body must be a valid JSON string representing the team details. Invalid JSON will cause request failure.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update teams.
  • Network Issues: Check connectivity to the Portainer server and that the base URL is correctly set.

Links and References

Discussion