NinjaOne icon

NinjaOne

Consume NinjaOne API

Actions158

System → Search

AI-generated

Overview

This node integrates with the NinjaOne API to perform various operations on different resources. Specifically, for the System resource with the Search operation, it allows users to search for devices or system entities based on a query string. This can include searching by device name, logged-on user name, IP address, or other identifying information.

Common scenarios where this node is beneficial include:

  • Quickly locating specific devices in an IT environment by partial or full identifiers.
  • Filtering devices to manage or audit them based on search criteria.
  • Automating workflows that require device lookup before performing further actions.

For example, an IT administrator could use this node to find all devices currently logged in by a particular user or to locate devices within a certain IP range.

Properties

Name Meaning
Q Search query string such as device name, logged-on user name, IP address, etc.
Limit Maximum number of devices to return. Set to 0 for no limit (returns all matching items).

Output

The node outputs an array of JSON objects representing the devices or system entities matching the search query. Each item in the output contains detailed information about a device as returned by the NinjaOne API's search endpoint.

The json field includes all relevant device data retrieved from the API.

This node does not output binary data.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests against the NinjaOne API.
  • The node uses HTTP GET requests to the NinjaOne API endpoints.
  • No additional external dependencies beyond the NinjaOne API and n8n's built-in HTTP request helpers.

Troubleshooting

  • Empty results: If the search returns no devices, verify that the query string (Q) is correctly specified and matches existing devices.
  • API authentication errors: Ensure the API key or OAuth2 credentials are valid and have sufficient permissions.
  • Limit parameter issues: Setting Limit to 0 means no limit; if too many results are returned, consider setting a reasonable limit to avoid performance issues.
  • Missing or malformed input: Make sure the Q property is provided as a non-empty string when performing a search.
  • Network or API errors: Check network connectivity and NinjaOne API status if requests fail unexpectedly.

Links and References

Discussion