Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Config Commit → Get One Config Commit

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a specific configuration commit. The "Get One Config Commit" operation fetches data for a single config commit identified by its unique ID, optionally including additional details and filtering by instance ID.

Typical use cases include:

  • Auditing or reviewing changes made in a particular configuration commit.
  • Automating workflows that depend on configuration state snapshots.
  • Integrating configuration commit data into reporting or monitoring systems.

For example, you might use this node to fetch the details of a config commit after a deployment to verify what changes were applied.

Properties

Name Meaning
Id The unique numeric identifier of the config commit to retrieve.
Includedetails Optional flag to specify whether to include detailed information in the response.
Instance Id Optional filter to specify the instance ID related to the config commit.

Output

The node outputs JSON data representing the requested config commit. This includes all standard fields returned by the Halo PSA API for a config commit, such as commit metadata, timestamps, author information, and optionally detailed content if Includedetails is set.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "author": "user@example.com",
  "timestamp": "2024-01-01T12:00:00Z",
  "message": "Updated configuration settings",
  "details": { /* present if Includedetails=true */ }
}

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects the base URL, tenant identifier, client ID, and client secret to be configured via credentials.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • Missing Credentials: If no credentials are provided or they are invalid, the node will throw an error indicating missing credentials. Ensure the API key and other required authentication details are correctly configured.
  • Invalid Resource or Operation: Errors occur if the specified resource or operation does not exist. Verify that "Config Commit" and "Get One Config Commit" are selected.
  • Invalid or Missing Id: Since the Id property is required, omitting it or providing an invalid value will cause the request to fail. Always provide a valid numeric ID.
  • API Request Failures: Network issues, incorrect base URL, or insufficient permissions can cause request failures. Check connectivity and API permissions.
  • JSON Parsing Errors: If additional query parameters or request bodies are malformed JSON, parsing errors may occur. Validate JSON inputs carefully.

Links and References

Discussion