NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Queries → Get Antivirus Status Report

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve an antivirus status report based on various filters. It is useful for IT administrators and security teams who want to monitor antivirus product states across devices managed by NinjaOne. By specifying filters such as device, timestamp, product state, and product name, users can query detailed antivirus status data, enabling proactive security management and compliance reporting.

Practical examples include:

  • Fetching the latest antivirus status for a specific device.
  • Monitoring antivirus product states over time using timestamps.
  • Filtering reports by antivirus product name or state to identify outdated or inactive installations.
  • Paginating through large result sets using cursor and page size parameters.

Properties

Name Meaning
Df Device filter: Filter results by a specific device identifier or criteria.
Ts Monitoring timestamp filter: Filter results based on a specific monitoring timestamp.
Product State Product State filter: Filter results by the antivirus product's state (e.g., active, inactive).
Product Name Product Name filter: Filter results by the name of the antivirus product.
Cursor Cursor name: Used for pagination to specify the position in the result set.
Page Size Limit number of records per page: Controls how many records are returned per API call.

Output

The node outputs JSON data representing the antivirus status report retrieved from the NinjaOne API. The structure of the JSON output corresponds directly to the API response, typically including details about devices, antivirus products, their states, timestamps, and pagination information if applicable.

If the API supports binary data for this operation, it is not indicated here; thus, the output is expected to be purely JSON.

Dependencies

  • Requires an API authentication token configured via OAuth2 credentials for NinjaOne.
  • Depends on the NinjaOne API being accessible and the user having appropriate permissions to query antivirus status reports.
  • No additional external dependencies beyond the NinjaOne API and n8n's HTTP request capabilities.

Troubleshooting

  • Common issues:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid filter values may result in empty responses or API errors.
    • Pagination parameters (cursor, page size) must be used correctly to navigate large datasets.
  • Error messages:
    • Authentication errors indicate problems with the API key or OAuth2 token; verify credentials.
    • Validation errors from the API suggest incorrect filter formats; check property values.
    • Network or timeout errors require checking connectivity to the NinjaOne API endpoint.

Links and References

Discussion