Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NinjaOne queries API is one of 22 APIs that NinjaOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include queries. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 24 operations across 24 paths, and defines 58 schemas. It is described by OpenAPI 3.0.1, at version 2.0.9-draft.

Requests are made against the base URL https://app.ninjarmm.com/v2.

24 operations 24 paths 58 schemas 24 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0.9-draft
Base URL
https://app.ninjarmm.com/v2
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NinjaOne queries API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearer) (oauth2). An API key is passed in the cookie as sessionKey (sessionKey). By default, every request must be authenticated.

Paths & Operations 24

Across 24 paths, the API surfaces 24 operations — 24 GET. Each is listed below with its method, path, parameters, and response codes.

queries 24

Queries

GET
/v2/queries/antivirus-status
Antivirus status report
getAntivirusStatusReport 6 params → default
GET
/v2/queries/antivirus-threats
Antivirus threats report
getAntivirusThreats 4 params → default
GET
/v2/queries/computer-systems
Computer systems report
getComputerSystems 4 params → default
GET
/v2/queries/custom-fields-detailed
Custom fields detailed report
getCustomFieldsDetailedReport 6 params → default
GET
/v2/queries/custom-fields
Custom fields report
getCustomFieldsReport 6 params → default
GET
/v2/queries/device-health
Device health report
getDeviceHealthReport 4 params → default
GET
/v2/queries/backup/usage
Device backup usage
getDeviceUsage 3 params → 200
GET
/v2/queries/disks
Disk drives report
getDiskDrives 4 params → default
GET
/v2/queries/os-patch-installs
OS Patch installation report
getInstalledOSPatches 6 params → default
GET
/v2/queries/software-patch-installs
Software Patch history report
getInstalledSoftwarePatches 9 params → default
GET
/v2/queries/logged-on-users
Last logged-on user report
getLastLoggedOnUsersReport 3 params → default
GET
/v2/queries/network-interfaces
List Network Interfaces
getNetworkInterfaces 3 params → default
GET
/v2/queries/operating-systems
Operating systems report
getOperatingSystems 4 params → default
GET
/v2/queries/os-patches
Pending, Failed and Rejected OS patches report
getPendingFailedRejectedOSPatches 7 params → default
GET
/v2/queries/software-patches
Pending, Failed and Rejected Software patches report
getPendingFailedRejectedSoftwarePatches 8 params → default
GET
/v2/queries/policy-overrides
Get summary of device policy overrides
getPolicyOverrides_1 3 params → default
GET
/v2/queries/processors
Processor report
getProcessors 4 params → default
GET
/v2/queries/raid-controllers
RAID controller report
getRAIDControllerReport 4 params → default
GET
/v2/queries/raid-drives
RAID drive report
getRAIDDriveReport 4 params → default
GET
/v2/queries/scoped-custom-fields-detailed
Scoped custom fields detailed report
getScopedCustomFieldsDetailedReport 6 params → default
GET
/v2/queries/scoped-custom-fields
Scoped custom fields report
getScopedCustomFieldsReport 6 params → default
GET
/v2/queries/software
Software inventory
getSoftware 5 params → default
GET
/v2/queries/volumes
Disk volumes report
getVolumes 5 params → default
GET
/v2/queries/windows-services
Windows services report
getWindowsServicesReport 5 params → default

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are NodeWithDetailedReferences (24 properties), User (20 properties), DeviceRAIDController (19 properties), DeviceHealthSummary (18 properties). Each schema is shown below with its type and property counts.

NodeAttributesDetailedReport
object
2 properties
DeviceLoggedOnUser
object
3 properties
BackupUsage
object
Device Backup Usage
14 properties
DeviceHealthSummary
object
18 properties
DeviceVolume
object
13 properties
VolumeBitLockerStatus
object
BitLocker Status
5 properties
DeviceDiskDrive
object
14 properties
DeviceWindowsService
object
8 properties
NetworkInterfacesReport
object
2 properties
DeviceNetworkInterfaces
object
14 properties
DeviceUsageReport
object
2 properties
RAIDControllerReport
object
2 properties
ScopedAttributesReport
object
2 properties
DeviceOSPatch
object
9 properties
NodeAttributes
object
2 properties
DevicePolicyOverrides
object
2 properties
AntivirusStatusReport
object
2 properties
NodeReferences
object
Expanded entity references
8 properties
RAIDDriveReport
object
2 properties
Location
object
Location
7 properties
WarrantyDates
object
Warranty Info
3 properties
SoftwareReport
object
2 properties
ComputerSystemsReport
object
2 properties
NodeRole
object
Device Role
11 properties
DeviceAntivirusThreat
object
12 properties
SoftwarePatchReport
object
2 properties
OperatingSystemsReport
object
2 properties
DeviceOperatingSystem
object
13 properties
NodeWithDetailedReferences
object
Device information.
24 properties
PolicyOverridesReport
object
2 properties
ProcessorReport
object
2 properties
DeviceHealthReport
object
2 properties
ScopedAttributes
object
3 properties
DiskDriveReport
object
2 properties
DeviceComputerSystem
object
13 properties
UserBasicInfo
object
3 properties
Maintenance
object
Maintenance mode status
3 properties
LoggedOnUsersReport
object
2 properties
NodeAttributesDetailed
object
4 properties
ScopedAttributesDetailedReport
object
2 properties
VolumesReport
object
2 properties
DeviceApplication
object
9 properties
DeviceRAIDDrive
object
15 properties
DeviceAntivirusStatus
object
6 properties
User
object
Assigned device owner
20 properties
AttributeValueUpdatedByInfo
object
Value source (who/what updated the value)
2 properties
Policy
object
Assigned policy (overrides organization and location policy mapping)
9 properties
DeviceRAIDController
object
19 properties
NodeAttributesReport
object
2 properties
AntivirusThreatsReport
object
2 properties
Organization
object
Organization
7 properties
WindowsServiceReport
object
2 properties
DeviceSoftwarePatch
object
9 properties
Cursor
object
4 properties
ScopedAttributesDetailed
object
3 properties
DeviceProcessor
object
8 properties
OSPatchReport
object
2 properties
NodeAttributeInfo
object
Field values
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-queries-api-openapi.yml Raw ↑

Other APIs NinjaOne publishes across the network.

NinjaOne Asset Tags API
NinjaOne Backup API
NinjaOne Checklist Templates API
NinjaOne Custom Fields API
NinjaOne Custom Tabs API
NinjaOne devices API
NinjaOne Document Templates API
NinjaOne groups API
NinjaOne Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API