Portainer icon

Portainer

Interact with Portainer via API

Actions190

Teams → Team Inspect

AI-generated

Overview

The node interacts with the Portainer API to inspect details of a specific team within Portainer. It is useful for retrieving detailed information about a team by its identifier, which can help in managing user groups and permissions programmatically. For example, an administrator could use this node to fetch team details before updating or auditing team configurations.

Properties

Name Meaning
Id Team identifier (number) used to specify which team to inspect

Output

The output JSON contains the detailed information of the inspected team as returned by the Portainer API. This typically includes properties such as the team's name, ID, associated users, and any other metadata related to the team configuration. The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The base URL for the Portainer instance must be configured in the node 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 likely return an error indicating the team was not found. Verify that the team ID is correct.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access team information.
  • Connection Issues: Confirm that the Portainer URL is reachable from the n8n environment and that there are no network restrictions.
  • Unexpected Response Format: If the API changes or returns unexpected data, the node may fail to parse the response correctly.

Links and References

Discussion