NinjaOne
App · 25 actions
Read NinjaOne devices, alerts and inventory and manage organizations and contacts.
Actions
| Action | What it does |
|---|---|
| Create contact | Create contact. |
| Create organization | Create organization. |
| Delete contact | Delete contact. |
| Get contact | Get contact. |
| Get device | Get device. |
| Get device custom fields | Get device custom fields. |
| Get organization | Get organization. |
| List activities | List activities. |
| List alerts | List alerts. |
| List contacts | List contacts. |
| List detailed devices | List detailed devices. |
| List device alerts | List device alerts. |
| List device disks | List device disks. |
| List device jobs | List device jobs. |
| List device network interfaces | List device network interfaces. |
| List device processors | List device processors. |
| List device software | List device software. |
| List device volumes | List device volumes. |
| List devices | List devices. |
| List organization devices | List organization devices. |
| List organization locations | List organization locations. |
| List organizations | List organizations. |
| List policies | List policies. |
| List scripts | List scripts. |
| Update contact | Update contact. |
Create contact
Create contact. Returns the service response.
Inputs
- Organization
organization_idnumber - Organizationid.
- First name
first_nametext - Firstname.
- Last name
last_nametext - Lastname.
- Email
emailtextRequired - Email.
- Phone
phonetext - Phone.
- Job title
job_titletext - Jobtitle.
- Manager uuid
manager_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 id
template_organization_idnumber - Templateorganizationid.
- Name
nametextRequired - Name.
- Description
descriptiontext - Description.
- User data
user_dataobject - Userdata.
- Node approval mode
node_approval_modetext - Nodeapprovalmode.One of:
AUTOMATIC,MANUAL,REJECT. - Locations
locationslist - Locations.
- Policies
policieslist - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - Id.
- With inheritance
with_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
- Id
idnumberRequired - 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 class
record_classtext - Class.One of:
SYSTEM,DEVICE,USER,ALL. - Before
beforedate and time - Before.
- After
afterdate and time - After.
- Older than
older_thannumber - Olderthan.
- Newer than
newer_thannumber - Newerthan.
- Type
typetext - Type.
- Status
statustext - Status.
- User
usertext - User.
- Series uid
series_uidtext - Seriesuid.
- Df
dftext - Df.
- Page size
page_sizenumber - Pagesize.From 10 to 1000.
- Lang
langtext - Lang.
- Tz
tztext - Tz.
- Start time
start_timedate and time - Starttime.
- End time
end_timedate and time - Endtime.
- Source config uid
source_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 type
source_typetext - Sourcetype.
- Df
dftext - Df.
- Lang
langtext - Lang.
- Tz
tztext - 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
- Df
dftext - Df.
- Page size
page_sizenumber - Pagesize.
- After
afternumber - 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
- Id
idnumberRequired - Id.
- Lang
langtext - Lang.
- Tz
tztext - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - Id.
- Lang
langtext - Lang.
- Tz
tztext - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - 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
- Id
idnumberRequired - Id.
- Include
includetext - 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
- Df
dftext - Df.
- Page size
page_sizenumber - Pagesize.
- After
afternumber - 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
- Id
idnumberRequired - Id.
- Page size
page_sizenumber - Pagesize.
- After
afternumber - 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
- Id
idnumberRequired - 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 size
page_sizenumber - Pagesize.
- After
afternumber - After.
- Of
oftext - 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
- Lang
langtext - 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
- Id
idnumberRequired - Id.
- First name
first_nametext - Firstname.
- Last name
last_nametext - Lastname.
- Email
emailtext - Email.
- Job title
job_titletext - Jobtitle.
- Organization
organization_idnumber - Organizationid.
- Phone
phonetext - 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"
}