Huntress icon

Huntress

Work with the Huntress API

Actions9

Overview

This node interacts with the Huntress API to retrieve detailed billing report information. Specifically, the "Get" operation under the "Billing Report" resource fetches a single billing report by its unique identifier. This is useful for scenarios where users need to access specific billing data for auditing, financial reconciliation, or reporting purposes within their automation workflows.

Practical examples include:

  • Automatically retrieving billing reports after a billing cycle to integrate with accounting systems.
  • Fetching billing details to trigger alerts or notifications based on usage or cost thresholds.
  • Archiving billing reports in external storage or databases for compliance and record-keeping.

Properties

Name Meaning
Billing Report ID The unique numeric identifier of the billing report to retrieve.

Output

The node outputs JSON data representing the billing report corresponding to the provided Billing Report ID. The structure of this JSON matches the billing report object returned by the Huntress API, typically including fields such as report metadata, billing period, charges, and related details.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to the Huntress API.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The base URL for API requests is https://api.huntress.io/v1.
  • Requests are made with Content-Type and Accept headers set to application/json.

Troubleshooting

  • Common issues:

    • Invalid or missing Billing Report ID will result in errors or empty responses.
    • Authentication failures due to incorrect or expired API tokens.
    • Network connectivity problems preventing access to the Huntress API endpoint.

  • Error messages:

    • Errors from the API may include HTTP status codes and messages indicating issues like unauthorized access (401), not found (404) if the Billing Report ID does not exist, or server errors (5xx).
    • Credential test failures return error status and message describing the problem, e.g., (401) Unauthorized.

  • Resolutions:

    • Verify that the Billing Report ID is correct and exists in the Huntress system.
    • Ensure the API key credential is valid and has necessary permissions.
    • Check network connectivity and proxy/firewall settings if applicable.

Links and References

Discussion