Portainer icon

Portainer

Interact with Portainer via API

Actions190

Teams → Team Create

AI-generated

Overview

This node allows you to create a new team within the "Teams" resource of the Portainer API. It is useful for automating team management tasks such as setting up new teams programmatically in your container management environment. For example, you can use this node to create teams based on organizational changes or onboarding workflows without manual intervention.

Properties

Name Meaning
Body The details of the team to be created, provided as a JSON string. This should include all necessary fields required by the Portainer API to define a team.

Output

The node outputs the response from the Portainer API after attempting to create the team. The output is structured as JSON and typically contains information about the newly created team, such as its ID, name, and other metadata returned by the API.

If the API supports it, binary data is not expected in this operation since it deals with JSON payloads describing team details.

Dependencies

  • Requires an API key credential for authenticating with the Portainer API.
  • The base URL for the Portainer API must be configured in the node credentials.
  • The node uses HTTP headers to specify JSON content type and accept JSON responses.

Troubleshooting

  • Invalid JSON in Body: If the "Body" property contains malformed JSON, the API request will fail. Ensure the JSON string is correctly formatted.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Verify that the API key and base URL are correctly set.
  • API Endpoint Issues: If the Portainer API endpoint is unreachable or incorrect, the node will throw connection errors. Confirm network connectivity and correct API URL.
  • Missing Required Fields: The API may reject requests missing mandatory team details. Check the Portainer API documentation for required fields in the team creation payload.

Links and References

Discussion