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 management API

Management

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

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

This API exposes 45 operations across 39 paths, and defines 48 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.

45 operations 39 paths 48 schemas 8 DELETE7 GET8 PATCH20 POST2 PUT

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 management 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 45

Across 39 paths, the API surfaces 45 operations — 8 DELETE, 7 GET, 8 PATCH, 20 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

management 45

Management

POST
/v2/contacts
Create a contact
createContact body → 200400403401
DELETE
/v2/contact/{id}
Delete a contact
deleteContact 1 param → 204400404403401
PATCH
/v2/contact/{id}
Update a contact
updateContact 1 param body → 200404400403401
GET
/v2/policies/{policy_id}/condition/custom-fields
Get custom fields policy conditions
getCustomFieldsPolicyConditions 1 param → default
POST
/v2/policies/{policy_id}/condition/custom-fields
Create custom fields policy condition
createCustomFieldsPolicyCondition 1 param body → default
GET
/v2/policies/{policy_id}/condition/windows-event
Get windows event conditions
getWindowsEventPolicyConditions 1 param → default
POST
/v2/policies/{policy_id}/condition/windows-event
Create windows event condition
createWindowsEventPolicyCondition 1 param body → default
DELETE
/v2/policies/{policy_id}/condition/{condition_id}
Delete policy condition
deletePolicyCondition 2 params → default
GET
/v2/policies/{policy_id}/condition/custom-fields/{condition_id}
Get custom fields policy condition
getCustomFieldsPolicyCondition 2 params → default
GET
/v2/policies/{policy_id}/condition/windows-event/{condition_id}
Get windows event condition
getWindowsEventPolicyCondition 2 params → default
POST
/v2/organizations
Create new organization
createOrganization 1 param body → default
POST
/v2/devices/approval/{mode}
Approve/Reject devices
nodeApprovalOperation 1 param body → default
DELETE
/v2/alert/{uid}
Reset alert/condition
resetAlert 1 param → default
POST
/v2/alert/{uid}/reset
Reset alert/condition and provide custom data for activity
resetAlertSetActivityData 1 param body → default
PUT
/v2/device/{id}/maintenance
Schedule maintenance
updateDeviceMaintenance 1 param body → default
DELETE
/v2/device/{id}/maintenance
Cancel maintenance
cancelDeviceMaintenance 1 param → default
POST
/v2/device/{id}/windows-service/{serviceId}/control
Windows service control
controlWindowsService 2 params body → default
PATCH
/v2/device/{id}
Update device information
updateDevice 1 param body → default
GET
/v2/device/{id}/dashboard-url
Device link
getDeviceLink 2 params → default
DELETE
/v2/device/{id}/policy/overrides
Reset device policy overrides
resetPolicyOverrides 1 param → default
POST
/v2/device/{id}/reboot/{mode}
Reboot device
rebootDevices 2 params body → default
DELETE
/v2/device/{id}/owner
Remove device owner
removeDeviceOwner 1 param → default
GET
/v2/device/{id}/scripting/options
Device scripting options
requestScriptingOptions 2 params → default
POST
/v2/device/{id}/script/run
Run script or built-in action
runScriptOnDevice 1 param body → default
POST
/v2/device/{id}/owner/{ownerUid}
Set device owner
setDeviceOwner 2 params → default
POST
/v2/device/{id}/windows-service/{serviceId}/configure
Modify Windows Service configuration
setWindowsServiceConfiguration 2 params body → default
POST
/v2/device/{id}/patch/os/apply
Run OS patch apply
submitOSPatchApply 1 param → 204400
POST
/v2/device/{id}/patch/os/scan
Run OS patch scan
submitOSPatchScan 1 param → 204400
POST
/v2/device/{id}/patch/software/apply
Run Software patch apply
submitSoftwarePatchApply 1 param → 204400
POST
/v2/device/{id}/patch/software/scan
Run Software patch scan
submitSoftwarePatchScan 1 param → 204400
POST
/v2/organization/{id}/locations
Add new location to organization
createLocationForOrganization 1 param body → default
POST
/v2/organization/generate-installer
Generate installer
getInstaller body → default
GET
/v2/organization/{id}/location/{location_id}/installer/{installer_type}
Generate installer
getInstallerForLocation 3 params → default
PATCH
/v2/organization/{id}
Update organization
updateOrganization 1 param body → default
PATCH
/v2/organization/{id}/locations/{locationId}
Update location
updateLocation 2 params body → default
PUT
/v2/organization/{id}/policies
Change organization policy mappings
updateNodeRolePolicyAssignmentForOrganization 1 param body → default
POST
/v2/policies
Creates new Policy
createPolicy 2 params body → default
POST
/v2/user/end-users
Create end user
createEndUser 1 param body → 200400401403
DELETE
/v2/user/end-user/{id}
Delete end user
deleteEndUser 1 param → 204400401403404
PATCH
/v2/user/end-user/{id}
Update a specific end user
patchEndUser 1 param body → 200404400403401
POST
/v2/user/technicians
Create a technician
createTechnician body → 200400401403
DELETE
/v2/user/technician/{id}
Delete a technician
deleteTechnician 1 param → 204400404401403
PATCH
/v2/user/technician/{id}
Update a technician
updateTechnician 1 param body → 200400404401403
PATCH
/v2/user/role/{roleId}/add-members
Add user role members
addUserRoleMembers 1 param body → 200400401403404
PATCH
/v2/user/role/{roleId}/remove-members
Remove users from user role
removeUserRoleMembers 1 param body → 200400401403404

Schemas 48

The contract defines 48 schemas that model the data the API accepts and returns. The most detailed are EndUser (17 properties), Technician (17 properties), WindowsEventPolicyConditionResponse (16 properties), CustomFieldPolicyConditionResponse (14 properties). Each schema is shown below with its type and property counts.

PolicyConditionInheritanceStatus
object
Policy condition inheritance status
3 properties
EndUserPatchRequest
object
Patch end user request payload
4 properties
UpdateTechnicianRequest
object
Update technician request payload
2 properties
OrganizationDetailed
object
10 properties
EndUser
object
17 properties
UserRole
object
5 properties
CreateContactRequest
object
Create contact request payload
6 properties
OrganizationSettings
object
Organization settings
5 properties
ScriptCategory
object
3 properties
Link
object
1 property
WindowsEventPolicyConditionCreateRequest
object
Windows event policy condition create request payload
13 properties 2 required
WindowsEventPolicyConditionResponse
object
Windows event policy condition response payload
16 properties
PolicyConditionScriptVariable
object
Policy condition script variable
2 properties
WindowsEventPolicyConditionOccurrence
object
Windows event policy condition occurrence
3 properties
Technician
object
17 properties
PolicyConditionCustomField
object
Policy condition custom field
3 properties 3 required
RunScriptRequest
object
5 properties
Script
object
8 properties
Location
object
Location
7 properties
LocationModel
object
6 properties
WarrantyDates
object
Warranty Info
3 properties
DeviceCredentialOptions
object
2 properties
FeatureSettings
object
Feature/product/integration configuration settings
4 properties
InstallerContent
object
content
1 property
WindowsEventPolicyConditionText
object
Windows event policy condition text
3 properties
DeviceScriptingOptions
object
3 properties
DeviceIDList
object
1 property
OrganizationWithLocationsAndPolicyAssignmentsModel
object
8 properties
CustomFieldsPolicyConditionCreateRequest
object
Custom fields policy condition create request payload
11 properties
PolicyInfo
object
5 properties
OrganizationModel
object
6 properties
WindowsServiceControlRequest
object
1 property
CredentialReference
object
3 properties
PolicyConditionScript
object
Policy condition script
4 properties
Contact
object
8 properties
CreateEndUserRequest
object
Create end user request payload
6 properties
MaintenanceSettings
object
3 properties
RebootRequest
object
1 property
CustomFieldPolicyConditionResponse
object
Custom fields policy condition response payload
14 properties
Policy
object
Assigned policy (overrides organization and location policy mapping)
9 properties
DeviceMutableProperties
object
7 properties
DeviceLink
object
2 properties
ContactPatchRequest
object
Patch contact request payload
6 properties
RoleMember
object
Role members
4 properties
CreateTechnicianRequest
object
Create technician request payload
4 properties
NodeRolePolicyAssignment
object
Node role policy assignments
2 properties
GenerateInstallerRequestDto
object
5 properties
WindowsServiceConfiguration
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ninjaone-management-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 organization API
NinjaOne Organization Checklists API