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 → Windows services report

AI-generated

Summary

Retrieve a report of Windows services from NinjaOne with optional filtering and pagination controls.

Inputs

  • returnAll — Boolean indicating whether to return all results (true) or just a single page (false).
  • additionalFields — Optional filters and parameters for the query, including device filter ('df'), service name ('name'), service state ('state'), cursor for pagination ('cursor'), and page size limit ('pageSize').
  • options — Additional optional settings such as custom JSON body overrides, custom HTTP headers, query string filters, batching controls, debug flag, pagination configuration, and request timeout.

Output shape

a JSON object containing a list of Windows services as per the applied filters and pagination settings

If 'returnAll' is false, only one page of results is returned; if true, multiple paginated requests are made automatically until all data is retrieved or maximum pages limit is reached. Debug information may be included if enabled.

Examples

Example 1: Fetch all Windows services that are currently running with a page size of 500

Set 'returnAll' to true, set 'additionalFields.state' to 'RUNNING', and 'additionalFields.pageSize' to 500

Links

Discussion