NinjaOne - A PowerShell module for NinjaOne software
Use the docs website for the most up-to-date information and a full automatically generated commandlet reference.
GET commands automatically combine pages for supported pagination endpoints, including
global locations, devices, organisations, queries, activities, and anchored ticketing lists.
Supplying -pageSize controls the size of each request; it does not limit the total results
or disable pagination. Page sizes above 1000 are capped at 1000 with a warning, including
ticket board requests. Smaller sizes are preserved and omitted sizes use the API default.
Ticket board requests retain their existing single-response behavior with -lastCursorId;
they are not automatically paginated.
For example, Get-NinjaOneLocations -pageSize 2000 requests pages of up to 1000 locations
and continues until all locations have been retrieved.
Get-NinjaOneDeviceGeolocationHistoryretrieves a page of mobile device geolocation history.-afterand-beforeaccept epoch seconds (including fractions); the window is limited to seven days. Use-pageSize(10-500) and-cursorfor pagination.Get-NinjaOneKnowledgeBaseArticle -articleId 1 -detailsretrieves the article object. Without-details, the existing download behavior is unchanged;-signedUrlsremains available.Get-NinjaOneGlobalKnowledgeBaseArticle -articleId 1retrieves a global article object.Get-NinjaOneGlobalCustomFieldsandSet-NinjaOneGlobalCustomFields -globalCustomFields @{ region = 'Europe' }retrieve and update global custom field values, not field definitions. Updates support-WhatIfand-Confirm.
Instance capability discovery warns and returns a null AppVersion when the version endpoint
returns HTML, another invalid response, or cannot be reached. Endpoint discovery still proceeds
using the OpenAPI specification; invalid version content is not cached or included in reports.
Common dev and build tooling lives under DevOps:
- Build: DevOps/Build/build.ps1, DevOps/Build/bootstrap.ps1
- Quality: DevOps/Quality/run-pssa.ps1, DevOps/Quality/test.ps1
- Help generation: DevOps/Help/Orchestrate-HelpGeneration.ps1