BVQ icon

BVQ

Get data from the BVQ API

Overview

This node retrieves data from the BVQ API, specifically fetching either the latest alerts or events based on user selection. It is useful for monitoring and integrating BVQ system alerts and events into automated workflows, enabling timely responses to system conditions.

Typical use cases include:

  • Fetching recent alerts from storage or hypervisor systems to trigger notifications or remediation workflows.
  • Retrieving event logs filtered by type and source for auditing or analysis purposes.
  • Integrating BVQ monitoring data into dashboards or reporting tools within n8n.

Properties

Name Meaning
Data Type Selects the type of data to retrieve: Alerts (latest alerts) or Events (latest events).
Event Source (Shown only if Data Type = Events) Selects the source of events: Hypervisor / vSphere or Storage / SVC.
Alert Source (Shown only if Data Type = Alerts) Selects the source of alerts: Hypervisor / vSphere, Storage / SVC, or All (both sources combined).
Event Type (Hypervisor) (Shown if Data Type = Events and Event Source = Hypervisor / vSphere) Selects the event type: Alarm, Event, or Task.
Event Type (Storage) (Shown if Data Type = Events and Event Source = Storage / SVC) Selects the event type: Alert (fixed), Alert (unfixed), Audit, Config, Expired, Message, or Monitoring.
Alert Type (Shown if Data Type = Alerts and Alert Source is Hypervisor / vSphere or Storage / SVC) Selects alert severity/type: Error, Info, Ok, Unknown, or Warn.
Time Value (Events) (Shown if Data Type = Events) Numeric value specifying the time period length to retrieve events from (e.g., 1).
Time Unit (Events) (Shown if Data Type = Events) Time unit for the time period: Minutes, Hours, Days, Weeks, or Months.
Time Value (Alerts) (Shown if Data Type = Alerts) Numeric value specifying the time period length to retrieve alerts from (e.g., 1).
Time Unit (Alerts) (Shown if Data Type = Alerts) Time unit for the time period: Minutes, Hours, Days, Weeks, or Months.

Output

The node outputs a single JSON object containing the data retrieved from the BVQ API:

  • For Alerts, the output JSON contains the latest alerts matching the selected source, alert type, and time range.
  • For Events, the output JSON contains the latest events filtered by source, event type, and time range.

The exact structure depends on the BVQ API response but generally includes arrays or objects representing alerts or events with their associated metadata.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the BVQ API.
  • The node uses HTTP Basic Authentication with username and password from the credentials.
  • The base URL for the BVQ API must be configured in the credentials.
  • Optionally supports ignoring SSL certificate issues based on credential configuration.

Troubleshooting

  • Missing credentials error: If the node throws "Missing credentials for BVQ API," ensure that the required API authentication credentials are properly set up in n8n.
  • API request failures: Errors like "BVQ API Request Failed" indicate network issues, incorrect URLs, invalid credentials, or server-side problems. Verify the API base URL, credentials, and network connectivity.
  • Empty or unexpected data: Check that the selected data type, source, and filters match available data in the BVQ system. Adjust time ranges or filter options accordingly.
  • SSL errors: If SSL verification fails, consider enabling the option to ignore SSL issues in the credentials, especially when using self-signed certificates.

Links and References

Discussion