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 notes https //app ninjarmm com/apidocs/?links active=core 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 parameters sourcetype string optional source type parameters df string optional device filter parameters lang string optional language tag parameters tz string optional time zone input example {"parameters" {"sourcetype" "string","df" "string","lang" "string","tz" "string"}} output parameter type description status code number http status code of the response reason string response reason phrase output example \[] 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 path parameters id number required device identifier input example {"path parameters" {"id" 1}} 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 userdata additionalprop1 object response data tags array output field tags fields object output field fields fields additionalprop1 object output field fields additionalprop1 fields additionalprop2 object output field fields additionalprop2 output 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 path parameters id number required device identifier input example {"path parameters" {"id" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" \[{"bytespersector" 0,"description" "string","interfacetype" "string","manufacturer" "string","mediatype" "string","model" "string","name" "string","partitioncount" 0,"serialnumber" "string","size" 0,"smartcapable"\ true,"status" "string"}]} 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 path parameters id number required device identifier input example {"path parameters" {"id" 1}} 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 output 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 path parameters id number required device identifier parameters status string optional patch status filter (failed, installed) parameters installedbefore string optional include patches installed before specified date parameters installedafter string optional include patches installed after specified date input example {"parameters" {"status" "failed","installedbefore" "","installedafter" ""},"path parameters" {"id" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" \[{"id" "3fa85f64 5717 4562 b3fc 2c963f66afa6","name" "string","severity" "string","status" "string","type" "string","installedat" 0,"kbnumber" "string"}]} 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 path parameters id number required device identifier parameters status string optional patch status filter parameters type string optional patch type filter parameters severity string optional patch severity filter input example {"path parameters" {"id" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" \[{"id" "3fa85f64 5717 4562 b3fc 2c963f66afa6","name" "string","severity" "string","status" "string","type" "string","installedat" 0,"kbnumber" "string"}]} 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 path parameters id number required device identifier parameters type string optional patch type filter parameters impact string optional patch impact filter parameters status string optional patch status filter parameters productidentifier string optional product identifier parameters installedbefore string optional include patches installed before specified date parameters installedafter string optional include patches installed after specified date input example {"path parameters" {"id" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {},"reason" "ok","json body" \[{"id" "3fa85f64 5717 4562 b3fc 2c963f66afa6","productidentifier" "3fa85f64 5717 4562 b3fc 2c963f66afa6","title" "string","impact" "string","status" "string","type" "string","installedat" 0}]} 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 parameters df string optional device filter parameters cursor string optional cursor name parameters pagesize number optional limit number of records per page input example {"parameters" {"pagesize" 1}} output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor cursor name string name of the resource cursor offset number output field cursor offset cursor count number count value cursor expires number output field cursor expires results array result of the operation results username string name of the resource results logontime number result of the operation results deviceid number unique identifier output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"cursor" {"name" "string","offset" 0,"count" 0,"expires" 0},"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 parameters df string optional device filter parameters cursor string optional cursor name parameters pagesize number optional limit number of records per page input example {"parameters" {"pagesize" 1}} output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor cursor name string name of the resource cursor offset number output field cursor offset cursor count number count value cursor expires number output field cursor expires results array result of the operation results adaptername string name of the resource results defaultgateway string result of the operation results interfacetype string type of the resource results dnshostname string name of the resource results dnsservers string result of the operation results interfaceindex string result of the operation results interfacename string name of the resource results ipaddress array result of the operation results linkspeed string result of the operation results macaddress array result of the operation results mtu string result of the operation results status string status value results subnetmask string result of the operation results deviceid number unique identifier output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"cursor" {"name" "string","offset" 0,"count" 0,"expires" 0},"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 parameters df string optional device filter parameters ts string optional monitoring timestamp filter parameters status string optional patch status filter parameters type string optional patch type filter parameters severity string optional patch severity filter parameters cursor string optional cursor name parameters pagesize number optional limit number of records per page input example {"parameters" {"pagesize" 1}} output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor cursor name string name of the resource cursor offset number output field cursor offset cursor count number count value cursor expires number output field cursor expires results array result of the operation results id string unique identifier results name string name of the resource results severity string result of the operation results status string status value results type string type of the resource results installedat number result of the operation results deviceid number unique identifier results timestamp number result of the operation results kbnumber string result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"cursor" {"name" "string","offset" 0,"count" 0,"expires" 0},"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 parameters df string optional device filter parameters cursor string optional cursor name parameters pagesize number optional limit number of records per page parameters installedbefore string optional include software installed before specified date parameters installedafter string optional include software installed after specified date input example {"parameters" {"pagesize" 1}} output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor cursor name string name of the resource cursor offset number output field cursor offset cursor count number count value cursor expires number output field cursor expires results array result of the operation results installdate string result of the operation results location string result of the operation results name string name of the resource results publisher string result of the operation results size number result of the operation results version string result of the operation results productcode string result of the operation results deviceid number unique identifier results timestamp number result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"cursor" {"name" "string","offset" 0,"count" 0,"expires" 0},"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 parameters df string optional device filter parameters ts string optional monitoring timestamp filter parameters status string optional patch status filter parameters productidentifier string optional product identifier parameters type string optional patch type filter parameters impact string optional patch impact filter parameters cursor string optional cursor name parameters pagesize number optional limit number of records per page input example {"parameters" {"pagesize" 1}} output parameter type description status code number http status code of the response reason string response reason phrase cursor object output field cursor cursor name string name of the resource cursor offset number output field cursor offset cursor count number count value cursor expires number output field cursor expires results array result of the operation results id string unique identifier results productidentifier string unique identifier results title string result of the operation results impact string result of the operation results status string status value results type string type of the resource results installedat number result of the operation results deviceid number unique identifier results timestamp number result of the operation output example {"status code" 200,"response headers" {},"reason" "ok","json body" {"cursor" {"name" "string","offset" 0,"count" 0,"expires" 0},"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