NinjaOne

App · 25 actions

Read NinjaOne devices, alerts and inventory and manage organizations and contacts.

Actions

ActionWhat it does
Create contactCreate contact.
Create organizationCreate organization.
Delete contactDelete contact.
Get contactGet contact.
Get deviceGet device.
Get device custom fieldsGet device custom fields.
Get organizationGet organization.
List activitiesList activities.
List alertsList alerts.
List contactsList contacts.
List detailed devicesList detailed devices.
List device alertsList device alerts.
List device disksList device disks.
List device jobsList device jobs.
List device network interfacesList device network interfaces.
List device processorsList device processors.
List device softwareList device software.
List device volumesList device volumes.
List devicesList devices.
List organization devicesList organization devices.
List organization locationsList organization locations.
List organizationsList organizations.
List policiesList policies.
List scriptsList scripts.
Update contactUpdate contact.

Create contact

Create contact. Returns the service response.

Inputs

Organizationorganization_idnumber
Organizationid.
First namefirst_nametext
Firstname.
Last namelast_nametext
Lastname.
EmailemailtextRequired
Email.
Phonephonetext
Phone.
Job titlejob_titletext
Jobtitle.
Manager uuidmanager_uuidtext
Manageruuid.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "email": "example",
    "firstName": "example",
    "id": 1,
    "jobTitle": "example",
    "lastName": "example",
    "organizationId": 1,
    "phone": "example",
    "uid": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create organization

Create organization. Returns the service response.

Inputs

Template organization idtemplate_organization_idnumber
Templateorganizationid.
NamenametextRequired
Name.
Descriptiondescriptiontext
Description.
User datauser_dataobject
Userdata.
Node approval modenode_approval_modetext
Nodeapprovalmode.One of: AUTOMATIC, MANUAL, REJECT.
Locationslocationslist
Locations.
Policiespolicieslist
Policies.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "description": "example",
    "id": 1,
    "locations": [],
    "name": "example",
    "nodeApprovalMode": "AUTOMATIC",
    "policies": [],
    "settings": {
      "backup": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "psa": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "splashtop": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "teamviewer": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "trayicon": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      }
    },
    "userData": {}
  },
  "has_more": false,
  "next_cursor": "example"
}

Delete contact

Delete contact. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

datanull
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Get contact

Get contact. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "email": "example",
    "firstName": "example",
    "id": 1,
    "jobTitle": "example",
    "lastName": "example",
    "organizationId": 1,
    "phone": "example",
    "uid": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get device

Get device. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "approvalStatus": "PENDING",
    "assignedOwnerUid": "example",
    "created": 1,
    "deviceType": "AgentDevice",
    "displayName": "example",
    "dnsName": "example",
    "id": 1,
    "ipAddresses": [],
    "lastContact": 1,
    "lastLoggedInUser": "example",
    "lastUpdate": 1,
    "locationId": 1,
    "macAddresses": [],
    "maintenance": {
      "end": 1,
      "reasonMessage": "example",
      "start": 1,
      "status": "PENDING"
    },
    "memory": {
      "capacity": 1
    },
    "netbiosName": "example",
    "nodeClass": "WINDOWS_SERVER",
    "nodeRoleId": 1,
    "notes": [],
    "offline": false,
    "organizationId": 1,
    "os": {
      "architecture": "example",
      "buildNumber": "example",
      "language": "example",
      "lastBootTime": 1,
      "locale": "example",
      "manufacturer": "example",
      "name": "example",
      "needsReboot": false,
      "releaseId": "example",
      "servicePackMajorVersion": 1,
      "servicePackMinorVersion": 1
    },
    "parentDeviceId": 1,
    "policyId": 1,
    "processors": [],
    "publicIP": "example",
    "references": {
      "assignedOwner": {
        "administrator": false,
        "assignedDeviceIds": [],
        "deviceIds": [],
        "email": "example",
        "enabled": false,
        "firstName": "example",
        "id": 1,
        "invitationStatus": "REGISTERED",
        "lastName": "example",
        "mfaConfigured": false,
        "mustChangePw": false,
        "notifyAllClients": false,
        "organizationId": 1,
        "permitAllClients": false,
        "phone": "example",
        "roles": [],
        "uid": "example",
        "userType": "TECHNICIAN"
      },
      "backupBandwidthThrottle": {
        "enabled": false,
        "nonWorkHoursKbps": 1,
        "nonWorkHoursUserUnit": "example",
        "workHoursKbps": 1,
        "workHoursUserUnit": "example",
        "workSchedule": {}
      },
      "backupUsage": {
        "cloudFileFolderSize": 1,
        "cloudImageSize": 1,
        "cloudImageV2Size": 1,
        "cloudNetworkShareSize": 1,
        "cloudTotalSize": 1,
        "lastFailedBackupJob": 1,
        "lastSuccessfulBackupJob": 1,
        "localFileFolderSize": 1,
        "localImageSize": 1,
        "localImageV2Size": 1,
        "localTotalSize": 1,
        "revisionsCurrentSize": 1,
        "revisionsDeletedSize": 1,
        "revisionsPreviousSize": 1,
        "revisionsTotalSize": 1
      },
      "location": {
        "address": "example",
        "description": "example",
        "id": 1,
        "name": "example",
        "userData": {}
      },
      "organization": {
        "description": "example",
        "id": 1,
        "name": "example",
        "nodeApprovalMode": "AUTOMATIC",
        "userData": {}
      },
      "policy": {
        "description": "example",
        "id": 1,
        "name": "example",
        "nodeClass": "WINDOWS_SERVER",
        "nodeClassDefault": false,
        "parentPolicyId": 1,
        "updated": 1
      },
      "role": {
        "chassisType": "UNKNOWN",
        "created": 1,
        "custom": false,
        "description": "example",
        "icon": "example",
        "id": 1,
        "name": "example",
        "nodeClass": "WINDOWS_SERVER",
        "nodeRoleParentId": 1
      },
      "rolePolicy": {
        "description": "example",
        "id": 1,
        "name": "example",
        "nodeClass": "WINDOWS_SERVER",
        "nodeClassDefault": false,
        "parentPolicyId": 1,
        "updated": 1
      },
      "warranty": {
        "endDate": 1,
        "manufacturerFulfillmentDate": 1,
        "startDate": 1
      }
    },
    "rolePolicyId": 1,
    "system": {
      "assetSerialNumber": "example",
      "biosSerialNumber": "example",
      "chassisType": "example",
      "domain": "example",
      "domainRole": "example",
      "manufacturer": "example",
      "model": "example",
      "name": "example",
      "numberOfProcessors": 1,
      "serialNumber": "example",
      "totalPhysicalMemory": 1,
      "virtualMachine": false
    },
    "systemName": "example",
    "tags": [],
    "uid": "example",
    "userData": {},
    "volumes": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Get device custom fields

Get device custom fields. Returns the service response.

Inputs

IdidnumberRequired
Id.
With inheritancewith_inheritancetrue/false
Withinheritance.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": "example"
}

Get organization

Get organization. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "description": "example",
    "id": 1,
    "locations": [],
    "name": "example",
    "nodeApprovalMode": "AUTOMATIC",
    "policies": [],
    "settings": {
      "backup": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "psa": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "splashtop": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "teamviewer": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      },
      "trayicon": {
        "enabled": false,
        "options": {},
        "product": "example",
        "targets": []
      }
    },
    "userData": {}
  },
  "has_more": false,
  "next_cursor": "example"
}

List activities

List activities. Returns one page; use the next page cursor to continue.

Inputs

Record classrecord_classtext
Class.One of: SYSTEM, DEVICE, USER, ALL.
Beforebeforedate and time
Before.
Afterafterdate and time
After.
Older thanolder_thannumber
Olderthan.
Newer thannewer_thannumber
Newerthan.
Typetypetext
Type.
Statusstatustext
Status.
Userusertext
User.
Series uidseries_uidtext
Seriesuid.
Dfdftext
Df.
Page sizepage_sizenumber
Pagesize.From 10 to 1000.
Langlangtext
Lang.
Tztztext
Tz.
Start timestart_timedate and time
Starttime.
End timeend_timedate and time
Endtime.
Source config uidsource_config_uidtext
Sourceconfiguid.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "activities": [],
    "lastActivityId": 1
  },
  "has_more": false,
  "next_cursor": "example"
}

List alerts

List alerts. Returns the service response.

Inputs

Source typesource_typetext
Sourcetype.
Dfdftext
Df.
Langlangtext
Lang.
Tztztext
Tz.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List contacts

List contacts. Returns the service response.

Inputs

None.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List detailed devices

List detailed devices. Returns one page; use the next page cursor to continue.

Inputs

Dfdftext
Df.
Page sizepage_sizenumber
Pagesize.
Afterafternumber
After.

Outputs

datalist
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device alerts

List device alerts. Returns the service response.

Inputs

IdidnumberRequired
Id.
Langlangtext
Lang.
Tztztext
Tz.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device disks

List device disks. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device jobs

List device jobs. Returns the service response.

Inputs

IdidnumberRequired
Id.
Langlangtext
Lang.
Tztztext
Tz.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device network interfaces

List device network interfaces. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device processors

List device processors. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device software

List device software. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List device volumes

List device volumes. Returns the service response.

Inputs

IdidnumberRequired
Id.
Includeincludetext
Include.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List devices

List devices. Returns one page; use the next page cursor to continue.

Inputs

Dfdftext
Df.
Page sizepage_sizenumber
Pagesize.
Afterafternumber
After.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List organization devices

List organization devices. Returns one page; use the next page cursor to continue.

Inputs

IdidnumberRequired
Id.
Page sizepage_sizenumber
Pagesize.
Afterafternumber
After.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List organization locations

List organization locations. Returns the service response.

Inputs

IdidnumberRequired
Id.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List organizations

List organizations. Returns one page; use the next page cursor to continue.

Inputs

Page sizepage_sizenumber
Pagesize.
Afterafternumber
After.
Ofoftext
Of.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List policies

List policies. Returns the service response.

Inputs

None.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

List scripts

List scripts. Returns the service response.

Inputs

Langlangtext
Lang.

Outputs

datalist
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": "example"
}

Update contact

Update contact. Returns the service response.

Inputs

IdidnumberRequired
Id.
First namefirst_nametext
Firstname.
Last namelast_nametext
Lastname.
Emailemailtext
Email.
Job titlejob_titletext
Jobtitle.
Organizationorganization_idnumber
Organizationid.
Phonephonetext
Phone.

Outputs

dataobject
The complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page cursor.
Example output
{
  "data": {
    "email": "example",
    "firstName": "example",
    "id": 1,
    "jobTitle": "example",
    "lastName": "example",
    "organizationId": 1,
    "phone": "example",
    "uid": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

On this page