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

Devices → Windows services

AI-generated

Summary

Retrieve Windows services running on a specific device by its identifier, optionally filtering by service name or state, with support for pagination and batching.

Inputs

  • id (required) — The unique numerical identifier of the device whose Windows services you want to retrieve.
  • returnAll — Whether to fetch all pages of results (true) or just a single page (false). Defaults to false.
  • additionalFields — Optional filters including 'Name' to match specific service names, and 'State' to filter by the service's current state such as RUNNING, STOPPED, PAUSED, etc.
  • options — Additional configurations including custom request body JSON (merged with other parameters), custom HTTP headers, query filters, batching controls (items per batch and delay between batches), debug flag to include detailed request info, pagination settings (mode, parameter names, limits, and delays), and request timeout.

Output shape

a list of Windows service objects associated with the specified device

When 'returnAll' is enabled, the node handles pagination automatically to retrieve all services; otherwise, only a single page of results is returned based on pagination settings. If 'debug' is enabled, output includes raw request details. Batch settings allow controlling request grouping and intervals for rate limiting.

Examples

Example 1: Fetch all Windows services for a device with ID 12345, filtering to only running services

Set 'id' to 12345, 'returnAll' to true, and in 'additionalFields' set 'State' to 'RUNNING'.

Links

Discussion