Ajax icon

Ajax

Consume Ajax API (v.0.1.2)
Join our community

Actions242

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including network-related actions such as updating device Ethernet settings. The node acts as a flexible interface to perform various API calls by specifying the resource and operation parameters.

For the Network resource and the Update Device Ethernet Settings operation, this node allows users to update the Ethernet configuration of a specific device within a hub for a given user. This can be useful in scenarios where network devices need remote configuration changes, such as updating IP settings, enabling/disabling Ethernet ports, or modifying other Ethernet-related parameters programmatically.

Practical examples:

  • Automating network device configuration updates after deployment.
  • Integrating network management into broader automation workflows.
  • Remotely adjusting device settings based on monitoring alerts or scheduled maintenance.

Properties

Name Meaning
User Id Identifier of the user owning or managing the device.
Hub Id Identifier of the hub where the device is located.
Device Id Identifier of the specific device whose Ethernet settings are to be updated.
Device Ethernet Settings The new Ethernet settings to apply to the device, typically provided as a JSON string.

Output

The node outputs data in the json field of its output items. This output will contain the response from the Ajax API after attempting to update the device's Ethernet settings. The structure typically includes confirmation of the update, any returned device state information, or error details if the update failed.

If the node supports binary data output, it would represent related binary content from the API response; however, based on the provided code and context, the primary output is JSON-formatted API response data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials leading to authentication failures.
    • Incorrect or malformed Device Ethernet Settings JSON causing API validation errors.
    • Nonexistent or incorrect User Id, Hub Id, or Device Id resulting in "not found" errors.
    • Network connectivity problems preventing API calls.

  • Error messages and resolutions:

    • Authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
    • Validation errors on Ethernet settings: Ensure the JSON string is well-formed and matches the expected schema for device Ethernet settings.
    • Resource not found errors: Double-check the IDs provided correspond to existing entities in the Ajax system.
    • Timeout or network errors: Confirm network access to the Ajax API endpoint and retry.

Links and References

Discussion