Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Config Commit → List Of Config Commit

AI-generated

Overview

This node integrates with the Halo PSA API to list configuration commits. It allows users to retrieve a filtered and ordered list of configuration commit records from their Halo PSA instance. This is useful for auditing changes, tracking configuration history, or automating workflows that depend on configuration state changes.

Typical use cases include:

  • Fetching recent configuration commits for review or reporting.
  • Filtering commits by instance ID or other criteria.
  • Paginating through large sets of commits.
  • Sorting commits by various fields in ascending or descending order.

Properties

Name Meaning
Advanced Search A string query parameter for advanced filtering of config commits.
Idonly Filter to return only IDs of the commits (boolean or similar).
Instance Id Filter commits belonging to a specific instance ID.
Notin Instance Id Exclude commits belonging to specified instance IDs.
Order Primary field to order the results by (string).
Order 2 Secondary field to order the results by (string).
Order 3 Tertiary field to order the results by (string).
Order 4 Fourth-level ordering field (string).
Order 5 Fifth-level ordering field (string).
Orderdesc Boolean or flag indicating if primary order should be descending.
Orderdesc 2 Descending flag for secondary order.
Orderdesc 3 Descending flag for tertiary order.
Orderdesc 4 Descending flag for fourth-level order.
Orderdesc 5 Descending flag for fifth-level order.
Page No Page number for paginated results (integer).
Page Size Number of items per page (integer).
Pageinate Flag to enable or disable pagination.
Rollback Commit Filter or flag related to rollback commits (string).
Search General search string to filter commits.

Output

The node outputs an array of JSON objects representing configuration commits retrieved from the Halo PSA API. Each item corresponds to one commit record with all its associated data fields as returned by the API.

If the API supports binary data for commits (not indicated here), it would be included accordingly, but this operation primarily returns JSON data.

Dependencies

  • Requires connection to the Halo PSA API.
  • Needs an API authentication credential configured in n8n with base URL, tenant identifier, client ID, and client secret.
  • The node uses HTTP requests with appropriate headers for authentication.
  • No additional external dependencies beyond the configured API credentials.

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credential is properly set up and connected.
  • Resource or Operation not found: Verify that the resource "Config Commit" and operation "List Of Config Commit" are correctly selected.
  • API request errors: Network issues, invalid parameters, or permission problems can cause errors. Check the error message returned in the output JSON for details.
  • Pagination issues: If too many results are requested without pagination, the API might reject the request or timeout. Use Page No and Page Size to control result size.
  • Invalid query parameters: Passing unsupported or malformed query parameters may cause the API to return errors. Double-check property values.

Links and References

Discussion