Ajax icon

Ajax

Consume Ajax API (v.0.1.2)

Actions242

Overview

This node, named "Ajax," is designed to interact with a specific Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Hub" resource with the "Get Hub Logs For Company" operation. The primary function of this operation is to retrieve logs related to a particular hub within a specified company.

Common scenarios for using this node include:

  • Monitoring activity or events recorded by a hub device associated with a company.
  • Auditing or troubleshooting issues by reviewing historical logs from a hub.
  • Integrating hub log data into workflows for alerting, reporting, or further processing.

For example, a user might configure the node to fetch logs from a security hub installed at a client’s site to analyze access events or system alerts.

Properties

Name Meaning
Company Id The unique identifier of the company whose hub logs are to be retrieved.
Hub Id The unique identifier of the hub device for which logs are requested.
Page (Optional) The page number of the logs to retrieve, useful for paginated results. Defaults to 1.

Output

The node outputs JSON data containing the logs retrieved from the specified hub for the given company. The structure typically includes an array of log entries, each representing an event or record from the hub's history.

If the API supports pagination, the output may also include metadata such as total pages or current page number.

The node does not explicitly mention binary data output, so it is assumed that all output is JSON-formatted log information.

Dependencies

  • Requires an API key credential to authenticate requests against the Ajax API.
  • Depends on the external Ajax API service being available and accessible.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution.

Troubleshooting

  • Missing or invalid credentials: Ensure that a valid API authentication token is configured in the node credentials.
  • Invalid Company Id or Hub Id: Verify that the provided identifiers exist and are correct; otherwise, the API may return errors or empty results.
  • Pagination issues: If requesting pages beyond the available range, the API might return empty data or errors.
  • Network or API downtime: Connectivity problems or Ajax API outages will cause request failures; check network status and API health.
  • Error messages from API: These should be reviewed in the node execution logs; common errors relate to authorization, invalid parameters, or rate limiting.

Links and References

Discussion