PortainerInstall

Overview

This node operation allows you to create a new Edge Group in the Portainer platform by sending the required EdgeGroup data. It is useful for automating the management of edge computing resources, grouping edge devices logically for easier deployment and monitoring.

Typical use cases include:

• Automatically provisioning new edge groups as part of infrastructure setup.
• Integrating with CI/CD pipelines to dynamically organize edge devices.
• Managing edge device clusters programmatically without manual intervention.

Properties

Output

The node outputs the response from the Portainer API after creating the Edge Group. The json output field contains the details of the newly created Edge Group, including its unique identifier and configuration as returned by the API.

If the API supports binary data in responses (not indicated here), it would typically represent files or attachments related to the Edge Group, but this node primarily deals with JSON data.

Dependencies

• Requires an active connection to a Portainer instance via its API.
• Needs an API authentication token or key configured in the node credentials to authorize requests.
• The base URL for the Portainer API must be set in the credentials.

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 authorization failures. Verify that the API key/token is correct and has sufficient permissions.
• API Endpoint Issues: Incorrect base URL or network connectivity problems can prevent communication with Portainer. Confirm the URL and network access.
• Validation Errors: The API may reject the EdgeGroup data if required fields are missing or invalid. Review the Portainer API documentation for the expected schema.

Links and References

• Portainer API Documentation
• Portainer Edge Groups Guide