NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

Queries → List Network Interfaces

AI-generated

Summary

Retrieve a list of network interfaces from the NinjaOne API, supporting pagination, filtering, and customization of the request.

Inputs

  • returnAll (required) — Boolean flag to determine whether to fetch all results across all pages (true) or only a single page of results (false).
  • additionalFields — Optional fields for refining the query, including 'Device filter' (df), 'Cursor' for cursor-based pagination, and 'Page Size' to specify how many items per page.
  • options — Collection of optional settings allowing custom JSON body content, additional HTTP headers, query-string filters, batching configuration, debug output enabling, pagination controls (including pagination mode, page parameter names, page size, cursor names, data path for results, max pages and request interval), and timeout duration for the HTTP request.

Output shape

a list of network interface objects as returned by the NinjaOne API

The shape and fields of each network interface object depend on the NinjaOne API response. The node supports pagination with configurable modes: offset-based, cursor-based, or next URL. Debug information can be included when enabled, showing details of HTTP requests made. Pagination parameters and filtering options can be customized via inputs to control the number and subset of results retrieved.

Examples

Example 1: Fetch all network interfaces with default pagination.

Set 'Return All' to true and leave other fields as default.

Example 2: Fetch a single page of network interfaces filtered by device and limited to 20 items.

Set 'Return All' to false, 'Device filter' to the target device id or name, and 'Page Size' to 20.

Links

Discussion