Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

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 network-related actions. For the Network resource, it can enable or disable an Ethernet network channel on a specified hub for a given user.

Typical use cases include:

  • Managing network connectivity settings remotely via API.
  • Automating enabling or disabling Ethernet channels on hubs within a network infrastructure.
  • Integrating network state control into broader automation workflows.

For example, you might use this node to programmatically turn off the Ethernet channel on a hub during maintenance windows or enable it when bringing devices online.

Properties

Name Meaning
User Id The identifier of the user associated with the network operation.
Hub Id The identifier of the hub whose Ethernet network channel state will be changed.
State Desired state of the Ethernet network channel; options are: ON (enable) or OFF (disable).

Output

The node outputs JSON data representing the result of the API call to enable or disable the Ethernet network channel. This typically includes confirmation of the action taken or any relevant status information returned by the Ajax API.

If the node supports binary data output, it would relate to any binary content returned by the API, but based on the provided code and context, the primary output is JSON structured response data.

Dependencies

  • Requires an API key credential for authenticating with the Ajax API.
  • Depends on the external Ajax API service being available and reachable.
  • Uses internal helper classes for HTTP communication, state management, and operation resolution.
  • No additional environment variables or n8n configurations beyond the API credential are explicitly required.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid User Id or Hub Id: Verify that the provided identifiers exist and are correct; otherwise, the API may return errors or fail silently.
  • Network connectivity issues: The node depends on reaching the Ajax API endpoint; network problems may cause timeouts or failures.
  • Invalid State value: Only "ON" or "OFF" are accepted; providing other values will likely cause validation errors.
  • API version mismatch: The node uses a specific API version; if the backend changes, some operations might fail until the node is updated.

Links and References

Discussion