NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

Queries → Get Device Health Report

AI-generated

Overview

This node interacts with the NinjaOne API to retrieve a device health report based on specified filters and pagination options. It is useful for IT administrators or support teams who want to monitor the health status of devices managed within NinjaOne, enabling them to filter devices by specific criteria and handle large result sets through pagination.

Practical examples include:

  • Fetching all devices with a particular health status (e.g., "healthy", "warning", "critical").
  • Filtering devices by a custom device filter string.
  • Paginating through large lists of device health reports using cursor and page size parameters.

Properties

Name Meaning
Df Device filter: a string used to filter devices according to custom criteria.
Health Health status filter: a string specifying the desired health status of devices to fetch.
Cursor Cursor name: a string used for pagination to indicate the position in the result set.
Page Size Limit number of records per page: a number defining how many records to return per page.

Output

The node outputs JSON data representing the device health report retrieved from the NinjaOne API. The structure corresponds to the API response for device health queries, typically including details about each device's health status and related metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the NinjaOne API via an OAuth2 API credential.
  • The node uses the NinjaOne API endpoint /v2/queries/device-health-report (inferred from context) with HTTP GET method.
  • Proper API authentication credentials must be configured in n8n for successful requests.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing invalid filter values may result in empty responses or API errors.
    • Pagination parameters (cursor, pageSize) must be correctly managed to avoid missing or duplicate data.
  • Error messages:

    • Errors returned from the NinjaOne API will be surfaced as error messages in the node output.
    • If no binary data is found when expected (not applicable here), an error would be thrown.
    • Network or permission errors should be checked by verifying API key validity and network connectivity.

Links and References

Discussion