WaAPI icon

WaAPI

Interact with WaAPI API

Actions83

Overview

The "List Instances" operation of the Instances resource allows users to retrieve a list of instances from the WaAPI API. This node is useful for scenarios where you need to fetch and display or process multiple instances, optionally filtered by specific criteria such as instance ID or name. For example, it can be used to monitor active instances, generate reports, or synchronize instance data with other systems.

Properties

Name Meaning
Filter Filter instances by ID or name. This string value is sent as a query parameter named filter to narrow down the list of returned instances based on matching IDs or names.

Output

The node outputs JSON data representing the list of instances retrieved from the API. Each item in the output typically corresponds to an instance object containing its details as provided by the WaAPI service. The exact structure depends on the API response but generally includes identifiers, names, and other relevant instance attributes.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the WaAPI API.
  • The base URL for API requests is https://waapi.app/api/v1.
  • The node uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Empty or no results: Ensure that the filter string is correctly specified and matches existing instance IDs or names. An incorrect or overly restrictive filter may return no data.
  • Authentication errors: Verify that the API key credential is valid and has the necessary permissions.
  • Network issues: Confirm network connectivity to https://waapi.app/api/v1.
  • Unexpected API responses: Check if the API endpoint or schema has changed; update the node configuration accordingly.

Links and References

Discussion