Evolution API

Overview

The node named "Evolution API" allows users to interact with the Evolution API service. Specifically, for the resource "Instance" and operation "Restart Instance," it enables restarting a specified instance by its name. This is useful in scenarios where an instance needs to be rebooted or refreshed remotely via API calls, such as recovering from errors, applying updates, or resetting state.

Practical example: A user managing multiple instances of a service can automate the restart process of a particular instance after deploying new configurations or when detecting performance issues, without manual intervention.

Properties

Output

The node outputs a JSON array containing the response from the Evolution API after attempting to restart the specified instance. The exact structure depends on the API's response but generally includes status information about the restart operation.

No binary data output is indicated.

Dependencies

• Requires an API key credential for authenticating with the Evolution API.
• The base URL for API requests is https://doc.evolution-api.com/api-reference.
• The node expects JSON responses and sends requests with appropriate headers (Accept: application/json, Content-Type: application/json).

Troubleshooting

• Operation not supported error: If the node throws an error stating that the operation is not supported, verify that the resource and operation names are correctly set to "instances-api" and "restart-instance" respectively.
• Authentication failures: Ensure that a valid API key credential is configured in n8n for the Evolution API.
• Instance not found or invalid instance name: Confirm that the "Instance Name" property matches exactly the name of an existing instance in the Evolution API system.
• Network or API errors: Check network connectivity and API availability; review API rate limits or permissions if applicable.

Links and References

• Evolution API Documentation (base URL and reference for API endpoints)