Binalyze AIR icon

Binalyze AIR

Manage Binalyze AIR resources

Actions99

Overview

The node interacts with the "Notification" resource of the Binalyze AIR system, specifically supporting the "Get Many" operation. This operation retrieves multiple user notifications from the system, allowing filtering and pagination.

Typical use cases include:

  • Fetching a list of all notifications for a user or system.
  • Filtering notifications by their read/unread status to process only new alerts.
  • Limiting the number of notifications retrieved per request for performance or UI display purposes.
  • Paging through large sets of notifications in batches.

For example, an automation workflow could periodically fetch unread notifications to alert a security team or archive old notifications after processing.

Properties

Name Meaning
Return All Whether to return all notifications or limit the results to a specified number.
Additional Fields A collection of optional filters and parameters:
- Filter By Read Status Filter notifications by their read status. Options: All, Read, Unread.
- Filter By Type Filter notifications by a specific notification type (string input).
- Limit Maximum number of notifications to return (minimum 1).
- Page Page number to retrieve when paginating results (minimum 1).

Output

The node outputs JSON data containing an array of notification objects. Each object represents a single notification with its associated details as provided by the Binalyze AIR API.

If binary data were involved (not indicated here), it would typically represent attachments or files related to notifications, but this operation focuses on JSON notification metadata.

Dependencies

  • Requires an API key credential for authenticating with the Binalyze AIR API.
  • The node depends on the Binalyze AIR service being accessible and properly configured.
  • No additional external dependencies are indicated beyond the API authentication.

Troubleshooting

  • Common Issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems preventing access to the Binalyze AIR API.
    • Requesting pages or limits outside valid ranges may cause errors or empty results.
    • Filtering by a non-existent notification type may return no results.
  • Error Messages:

    • "Unknown resource" error if the resource parameter is incorrectly set.
    • API errors indicating unauthorized access usually mean the API key is invalid or expired.
    • Pagination errors if page or limit values are less than 1.
  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Check network connectivity and endpoint URL configurations.
    • Use valid filter values and ensure pagination parameters are within allowed ranges.

Links and References

Discussion