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 devices API is one of 22 APIs that NinjaOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 18 operations across 17 paths, and defines 27 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.

18 operations 17 paths 27 schemas 17 GET1 PATCH

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 devices 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 18

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

devices 18

Devices

GET
/v2/device/{id}
Device details
getDevice 1 param → 200
GET
/v2/device/{id}/jobs
Device currently running (active) jobs
getDeviceActiveJobs 3 params → default
GET
/v2/device/{id}/activities
Device activities
getDeviceActivities 9 params → default
GET
/v2/device/{id}/alerts
Device alerts (triggered conditions)
getDeviceAlerts 3 params → default
GET
/v2/device/{id}/disks
Device disk drives
getDeviceDiskDrives 1 param → default
GET
/v2/device/{id}/os-patch-installs
OS Patch installation report for device
getDeviceInstalledOSPatches 4 params → default
GET
/v2/device/{id}/software-patch-installs
Software Patch history for device
getDeviceInstalledSoftwarePatches 7 params → default
GET
/v2/device/{id}/last-logged-on-user
Last logged-on user information
getDeviceLastLoggedOnUser 1 param → default
GET
/v2/device/{id}/network-interfaces
Device network interfaces
getDeviceNetworkInterfaces 1 param → default
GET
/v2/device/{id}/os-patches
OS Patches
getDevicePendingFailedRejectedOSPatches 4 params → default
GET
/v2/device/{id}/software-patches
Pending, Failed and Rejected Software patches for device
getDevicePendingFailedRejectedSoftwarePatches 5 params → default
GET
/v2/device/{id}/processors
Device processors
getDeviceProcessors 1 param → default
GET
/v2/device/{id}/windows-services
Windows services
getDeviceServices 3 params → default
GET
/v2/device/{id}/software
Device software inventory
getDeviceSoftware 1 param → default
GET
/v2/device/{id}/volumes
Device storage volumes
getDeviceVolumes 2 params → default
GET
/v2/device/{id}/custom-fields
Device custom fields
getNodeCustomFields 2 params → default
PATCH
/v2/device/{id}/custom-fields
Update Field Values
updateNodeAttributeValues 1 param body → default
GET
/v2/device/{id}/policy/overrides
Get summary of device policy overrides
getPolicyOverrides 1 param → default

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are Device (29 properties), NodeWithDetailedReferences (24 properties), User (20 properties), Activity (17 properties). Each schema is shown below with its type and property counts.

Processor
object
Processors
6 properties
Activity
object
17 properties
BackupUsage
object
Device Backup Usage
14 properties
VolumeBitLockerStatus
object
BitLocker Status
5 properties
Application
object
7 properties
LoggedOnUser
object
2 properties
NodeReferences
object
Expanded entity references
8 properties
Location
object
Location
7 properties
Job
object
17 properties
WindowsService
object
6 properties
DiskDrive
object
12 properties
WarrantyDates
object
Warranty Info
3 properties
Device
object
29 properties
NodeRole
object
Device Role
11 properties
NodeWithDetailedReferences
object
Device information.
24 properties
SoftwarePatch
object
7 properties
NetworkInterface
object
13 properties
PolicyOverrides
object
1 property
Alert
object
14 properties
Maintenance
object
Maintenance mode status
3 properties
NodeActivitiesResponse
object
3 properties
User
object
Assigned device owner
20 properties
Note
object
Device Notes
1 property
Policy
object
Assigned policy (overrides organization and location policy mapping)
9 properties
Organization
object
Organization
7 properties
Volume
object
Disk Volumes
11 properties
OSPatch
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-devices-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 Document Templates API
NinjaOne groups API
NinjaOne Knowledge Base Articles API
NinjaOne Location API
NinjaOne management API
NinjaOne organization API
NinjaOne Organization Checklists API