Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Connected Instance → Get One Connected Instance

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data about connected instances. Specifically, the "Get One Connected Instance" operation fetches detailed information about a single connected instance by its unique identifier. This is useful in scenarios where you need to programmatically access configuration or status details of a specific connected instance within your Halo PSA environment.

Practical examples include:

  • Automating audits or reports that require fetching details of particular connected instances.
  • Integrating Halo PSA connected instance data into other systems or workflows.
  • Triggering conditional logic based on the properties of a connected instance.

Properties

Name Meaning
Id The unique numeric identifier of the connected instance to retrieve.
Includedetails Optional flag (true/false) indicating whether to include detailed information in output.

Output

The node outputs JSON data representing the connected instance retrieved from the Halo PSA API. The structure corresponds to the API response for a single connected instance and includes all relevant fields such as instance ID, name, status, and optionally detailed nested information if Includedetails is set.

If the node encounters an error during the request, it outputs a JSON object with an error property containing the error message.

No binary data output is produced by this operation.

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 API requests via custom headers.
  • No additional external dependencies beyond the Halo PSA API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent Id will result in API errors or empty responses.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "No credentials returned!": Indicates that the required API credentials were not provided or could not be loaded. Ensure credentials are configured correctly in n8n.
    • Errors returned from the API (e.g., 404 Not Found) will be passed through in the error field of the output JSON if "Continue On Fail" is enabled.

  • Resolution tips:

    • Verify that the API credentials are correct and have sufficient permissions.
    • Confirm that the Id parameter corresponds to an existing connected instance.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion