Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Instance → List Of Instance

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Instance resource and the List Of Instance operation, it retrieves a list of instances from the Halo PSA system. This is useful in scenarios where you want to fetch and process instance data such as configurations, statuses, or other metadata managed by Halo PSA.

Practical examples include:

  • Automating reporting workflows that require up-to-date instance information.
  • Synchronizing instance data with other systems or databases.
  • Triggering downstream processes based on instance attributes or changes.

Properties

Name Meaning
Comparewith A query parameter used to filter or compare instances when listing them. The exact values depend on the API's accepted parameters for this field.

Note: The property Comparewith is sent as a query parameter named comparewith in the API request.

Output

The node outputs an array of JSON objects representing the instances retrieved from the Halo PSA API. Each item corresponds to one instance and contains all relevant data fields returned by the API for that instance.

If the API returns binary data (not typical for this operation), it would be included in the binary output section, but for the "List Of Instance" operation, the output is purely JSON.

Example output structure (simplified):

[
  {
    "id": "instance-id-1",
    "name": "Instance Name 1",
    "status": "active",
    "otherFields": "..."
  },
  {
    "id": "instance-id-2",
    "name": "Instance Name 2",
    "status": "inactive",
    "otherFields": "..."
  }
]

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node uses these credentials to authenticate requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n core modules.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot retrieve the required API credentials. Ensure that the credentials are properly configured in n8n and assigned to the node.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the correct resource ("Instance") and operation ("List Of Instance") names are selected.

  • API request errors
    Errors from the Halo PSA API (e.g., authentication failures, invalid parameters) will be surfaced. Check the error message for details and confirm that credentials and parameters like comparewith are correct.

  • JSON parsing errors
    If additional JSON parameters are provided incorrectly, parsing may fail. Ensure any JSON input fields are well-formed.

  • Continue On Fail behavior
    If enabled, the node will continue processing subsequent items even if some fail, returning error details in the output JSON.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion