Portainer icon

Portainer

Interact with Portainer via API

Actions190

Teams → Team List

AI-generated

Overview

This node operation lists teams from the Portainer platform. It is useful for retrieving a collection of teams that a user can access or manage within an environment. Common scenarios include displaying all teams a user leads or filtering teams by specific environments to organize resources and permissions effectively.

For example, a user might want to list only the teams they lead to quickly access their managed groups or filter teams by environment ID to see which teams are authorized in a particular deployment context.

Properties

Name Meaning
Additional Fields A collection of optional filters:
- Only Led Teams Boolean option to list only teams where the user is the leader (true/false).
- Environment Id Numeric identifier to filter teams authorized for a specific environment (endpoint).

Output

The output consists of JSON data representing the list of teams retrieved from the Portainer API. Each item in the output array corresponds to a team object with its associated properties as returned by the API.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Portainer API.
  • The node uses the base URL provided in the credentials to connect to the Portainer instance.
  • The operation sends HTTP GET requests with query parameters based on the input properties.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect environment IDs may result in empty results or errors.
    • Network connectivity problems to the Portainer server will prevent data retrieval.
  • Error messages:

    • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
    • "Not Found" or similar errors may mean the environment ID does not exist or the user lacks permission.
    • Timeout or connection errors suggest network issues; check server availability and firewall settings.

Links and References

Discussion