PortainerInstall

Overview

This node operation allows creating an Edge Job in Portainer by sending raw string data as the request body. It is useful when you want to define or update an Edge Job using a JSON string or other string-encoded data format directly, without using structured fields in the node UI.

Typical use cases include:

• Automating deployment of Edge Jobs by providing full job definitions as JSON strings.
• Integrating with external systems that generate Edge Job configurations as strings.
• Quickly testing or applying complex Edge Job configurations without mapping each property individually.

Properties

Output

The node outputs the response from the Portainer API after creating the Edge Job. The output is available in the json field and typically contains details about the created Edge Job such as its ID, status, and configuration as returned by the API.

No binary data output is expected for this operation.

Dependencies

• Requires an active connection to a Portainer instance via an API key credential.
• The node uses the Portainer API endpoint configured in the credentials, specifically targeting the /api base URL.
• Proper permissions on the Portainer API are necessary to create Edge Jobs.

Troubleshooting

• Invalid JSON or malformed string in Body: If the provided string is not valid JSON or does not conform to the expected Edge Job schema, the API will reject the request. Ensure the string is correctly formatted.
• Authentication errors: If the API key or URL is incorrect or lacks permissions, the node will fail to authenticate. Verify credentials and access rights.
• API endpoint unreachable: Network issues or incorrect Portainer URL can cause connection failures. Confirm network connectivity and correct URL.
• Unexpected API errors: Check the exact error message returned in the node output for clues; it may indicate missing required fields or invalid values in the Edge Job definition.

Links and References

• Portainer API Documentation
• Portainer Edge Jobs Guide