NinjaOne
58 min
the ninjaone connector allows for automated it operations and endpoint management through swimlane turbine, providing efficient patch management and device monitoring ninjaone is a unified it operations platform that simplifies the way it teams work, offering a suite of tools for device management, monitoring, and security the ninjaone connector for swimlane turbine enables users to automate the retrieval of critical device and network information, manage alerts, and oversee software and os patching directly within the swimlane ecosystem by integrating with ninjaone, swimlane turbine users gain the ability to streamline their security operations, enhance endpoint visibility, and maintain system health with minimal manual intervention prerequisites or asset setup this connector supports the following authentication types api key authentication oauth2 0 client credentials authentication api key authentication session key and url are required oauth2 0 client credentials authentication below fields are required to get access token for authorizing api's client id ( required ) client secret ( required ) url ( required ) scopes ( required )= array of scopes token url capabilities this connector provides the following capabilities get alerts get device by id get device disk drives get last logged on user get os patch installs get os patches by device id get software patch history list logged on users list network interfaces list os patches list software inventory list software patches configurations ninjaone api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required sessionkey session key string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional ninjaone oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required token url string optional client id the client id string required client secret the client secret string required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions get alerts fetches a list of alerts from ninjaone, providing an overview of triggered conditions across the network endpoint url /v2/alerts method get input argument name type required description sourcetype string optional source type df string optional device filter lang string optional language tag tz string optional time zone output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" \[] } ] get device by id retrieve detailed information for a specific device in ninjaone using its unique identifier endpoint url /v2/device/{{id}} method get input argument name type required description id number required device identifier output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier parentdeviceid number unique identifier organizationid number unique identifier locationid number unique identifier nodeclass string output field nodeclass noderoleid number unique identifier rolepolicyid number unique identifier policyid number unique identifier approvalstatus string status value offline boolean output field offline displayname string name of the resource systemname string name of the resource dnsname string name of the resource netbiosname string name of the resource created number output field created lastcontact number output field lastcontact lastupdate number date value userdata object response data additionalprop1 object output field additionalprop1 tags array output field tags fields object output field fields additionalprop1 object output field additionalprop1 additionalprop2 object output field additionalprop2 example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "id" 0, "parentdeviceid" 0, "organizationid" 0, "locationid" 0, "nodeclass" "windows server", "noderoleid" 0, "rolepolicyid" 0, "policyid" 0, "approvalstatus" "pending", "offline" true, "displayname" "string", "systemname" "string", "dnsname" "string", "netbiosname" "string", "created" 0 } } ] get device disk drives retrieve disk drive information from a specified device using ninjaone, including storage capacity and usage endpoint url /v2/device/{{id}}/disks method get input argument name type required description id number required device identifier output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" \[ {} ] } ] get last logged on user retrieve the last logged on user details from a specified device using ninja one endpoint url /v2/device/{{id}}/last logged on user method get input argument name type required description id number required device identifier output parameter type description status code number http status code of the response reason string response reason phrase username string name of the resource logontime number time value example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "username" "string", "logontime" 0 } } ] get os patch installs retrieve a list of installed os patches from ninjaone, providing an overview of system updates and security fixes endpoint url /v2/device/{{id}}/os patch installs method get input argument name type required description id number required device identifier status string optional patch status filter (failed, installed) installedbefore string optional include patches installed before specified date installedafter string optional include patches installed after specified date output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" \[ {} ] } ] get os patches by device id retrieve a list of operating system patches available for a specific device using its unique identifier endpoint url /v2/device/{{id}}/os patches method get input argument name type required description id number required device identifier status string optional patch status filter type string optional patch type filter severity string optional patch severity filter output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" \[ {} ] } ] get software patch history retrieve the historical patching data for software managed by ninjaone, including patch dates and statuses endpoint url /v2/device/{{id}}/software patch installs method get input argument name type required description id number required device identifier type string optional patch type filter impact string optional patch impact filter status string optional patch status filter productidentifier string optional product identifier installedbefore string optional include patches installed before specified date installedafter string optional include patches installed after specified date output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" \[ {} ] } ] list logged on users retrieve a list of users currently logged on to a system using ninjaone, providing real time session information endpoint url /v2/queries/logged on users method get input argument name type required description df string optional device filter cursor string optional cursor name pagesize number optional limit number of records per page output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor name string name of the resource offset number output field offset count number count value expires number output field expires results array result of the operation username string name of the resource logontime number time value deviceid number unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "cursor" {}, "results" \[] } } ] list network interfaces retrieve a list of network interfaces from ninjaone, providing an overview of each interface's status and configuration endpoint url /v2/queries/network interfaces method get input argument name type required description df string optional device filter cursor string optional cursor name pagesize number optional limit number of records per page output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor name string name of the resource offset number output field offset count number count value expires number output field expires results array result of the operation adaptername string name of the resource defaultgateway string output field defaultgateway interfacetype string type of the resource dnshostname string name of the resource dnsservers string output field dnsservers interfaceindex string output field interfaceindex interfacename string name of the resource ipaddress array output field ipaddress linkspeed string output field linkspeed macaddress array output field macaddress mtu string output field mtu status string status value subnetmask string output field subnetmask deviceid number unique identifier example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "cursor" {}, "results" \[] } } ] list os patches retrieve a list of available operating system patches from ninjaone for targeted endpoint management endpoint url /v2/queries/os patches method get input argument name type required description df string optional device filter ts string optional monitoring timestamp filter status string optional patch status filter type string optional patch type filter severity string optional patch severity filter cursor string optional cursor name pagesize number optional limit number of records per page output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor name string name of the resource offset number output field offset count number count value expires number output field expires results array result of the operation id string unique identifier name string name of the resource severity string output field severity status string status value type string type of the resource installedat number output field installedat deviceid number unique identifier timestamp number output field timestamp kbnumber string output field kbnumber example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "cursor" {}, "results" \[] } } ] list software inventory retrieve a comprehensive list of software installed across endpoints managed by ninjaone endpoint url /v2/queries/software method get input argument name type required description df string optional device filter cursor string optional cursor name pagesize number optional limit number of records per page installedbefore string optional include software installed before specified date installedafter string optional include software installed after specified date output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor name string name of the resource offset number output field offset count number count value expires number output field expires results array result of the operation installdate string date value location string output field location name string name of the resource publisher string output field publisher size number output field size version string output field version productcode string output field productcode deviceid number unique identifier timestamp number output field timestamp example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "cursor" {}, "results" \[] } } ] list software patches retrieve a list of available software patches from ninjaone for efficient update management endpoint url /v2/queries/software patches method get input argument name type required description df string optional device filter ts string optional monitoring timestamp filter status string optional patch status filter productidentifier string optional product identifier type string optional patch type filter impact string optional patch impact filter cursor string optional cursor name pagesize number optional limit number of records per page output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor name string name of the resource offset number output field offset count number count value expires number output field expires results array result of the operation id string unique identifier productidentifier string unique identifier title string output field title impact string output field impact status string status value type string type of the resource installedat number output field installedat deviceid number unique identifier timestamp number output field timestamp example \[ { "status code" 200, "response headers" {}, "reason" "ok", "json body" { "cursor" {}, "results" \[] } } ] response headers header description example content type the media type of the resource application/json date the date and time at which the message was originated thu, 01 jan 2024 00 00 00 gmt notes api documentation https //app ninjarmm com/apidocs/?links active=core