{ "opencollection": "1.0.0", "info": { "name": "NinjaOne Public API 2.0 Asset Tags queries API", "version": "2.0.9-draft" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "queries", "type": "folder" }, "items": [ { "info": { "name": "Antivirus status report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/antivirus-status", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "productState", "value": "", "type": "query", "description": "Product State filter" }, { "name": "productName", "value": "", "type": "query", "description": "Product Name filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of statues of antivirus software installed on devices" }, { "info": { "name": "Antivirus threats report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/antivirus-threats", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of antivirus threats" }, { "info": { "name": "Computer systems report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/computer-systems", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns computer systems information for devices" }, { "info": { "name": "Custom fields detailed report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/custom-fields-detailed", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Custom fields updated after specified date" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields" }, { "name": "showSecureValues", "value": "", "type": "query", "description": "Flag to indicate if secure values should be returned as plain text without encryption" } ] }, "docs": "Returns Custom Fields report with additional information about each field" }, { "info": { "name": "Custom fields report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/custom-fields", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Custom fields updated after specified date" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields" }, { "name": "showSecureValues", "value": "", "type": "query", "description": "Flag to indicate if secure values should be returned as plain text without encryption" } ] }, "docs": "Returns Custom Fields report" }, { "info": { "name": "Device health report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/device-health", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "health", "value": "", "type": "query", "description": "Health status filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of device health summary records" }, { "info": { "name": "Device backup usage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/backup/usage", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "includeDeletedDevices", "value": "", "type": "query", "description": "Whether or not include deleted devices" } ] }, "docs": "Returns the backup usage by device" }, { "info": { "name": "Disk drives report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/disks", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of physical disks" }, { "info": { "name": "OS Patch installation report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/os-patch-installs", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "status", "value": "", "type": "query", "description": "Patch Status filter (FAILED, INSTALLED)" }, { "name": "installedBefore", "value": "", "type": "query", "description": "Include patches installed before specified date" }, { "name": "installedAfter", "value": "", "type": "query", "description": "Include patches installed after specified date" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns patch installation history records (successful and failed)" }, { "info": { "name": "Software Patch history report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/software-patch-installs", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "type", "value": "", "type": "query", "description": "Patch Type filter" }, { "name": "impact", "value": "", "type": "query", "description": "Patch Impact filter" }, { "name": "status", "value": "", "type": "query", "description": "Patch Status filter" }, { "name": "productIdentifier", "value": "", "type": "query", "description": "Product Identifier" }, { "name": "installedBefore", "value": "", "type": "query", "description": "Include patches installed before specified date" }, { "name": "installedAfter", "value": "", "type": "query", "description": "Include patches installed after specified date" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns 3rd party software patch installation history records (successful and failed)" }, { "info": { "name": "Last logged-on user report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/logged-on-users", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns usernames and logon times " }, { "info": { "name": "List Network Interfaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/network-interfaces", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query" } ] }, "docs": "Returns list of Network Interfaces for each device" }, { "info": { "name": "Operating systems report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/operating-systems", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns operating systems' for devices" }, { "info": { "name": "Pending, Failed and Rejected OS patches report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/os-patches", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "status", "value": "", "type": "query", "description": "Patch Status filter" }, { "name": "type", "value": "", "type": "query", "description": "Patch Type filter" }, { "name": "severity", "value": "", "type": "query", "description": "Patch Severity filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of OS patches for which there were no installation attempts" }, { "info": { "name": "Pending, Failed and Rejected Software patches report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/software-patches", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "status", "value": "", "type": "query", "description": "Patch Status filter" }, { "name": "productIdentifier", "value": "", "type": "query", "description": "Product Identifier" }, { "name": "type", "value": "", "type": "query", "description": "Patch Type filter" }, { "name": "impact", "value": "", "type": "query", "description": "Patch Impact filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of 3rd party Software patches for which there were no installation attempts" }, { "info": { "name": "Get summary of device policy overrides", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/policy-overrides", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of overridden policy sections for each device" }, { "info": { "name": "Processor report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/processors", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of processors" }, { "info": { "name": "RAID controller report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/raid-controllers", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of RAID controllers" }, { "info": { "name": "RAID drive report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/raid-drives", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of drives connected to RAID controllers" }, { "info": { "name": "Scoped custom fields detailed report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/scoped-custom-fields-detailed", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Custom fields updated after specified date" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields" }, { "name": "scopes", "value": "", "type": "query", "description": "Comma-separated list of scopes" }, { "name": "showSecureValues", "value": "", "type": "query", "description": "Flag to indicate if secure values should be returned as plain text without encryption" } ] }, "docs": "Returns report for Custom Fields defined at different scopes (device, location, organization) with additional information about each field" }, { "info": { "name": "Scoped custom fields report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/scoped-custom-fields", "params": [ { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "updatedAfter", "value": "", "type": "query", "description": "Custom fields updated after specified date" }, { "name": "fields", "value": "", "type": "query", "description": "Comma-separated list of fields" }, { "name": "scopes", "value": "", "type": "query", "description": "Comma-separated list of scopes" }, { "name": "showSecureValues", "value": "", "type": "query", "description": "Flag to indicate if secure values should be returned as plain text without encryption" } ] }, "docs": "Returns report for Custom Fields defined at different scopes (device, location, organization)" }, { "info": { "name": "Software inventory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/software", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "installedBefore", "value": "", "type": "query", "description": "Include software installed before specified date" }, { "name": "installedAfter", "value": "", "type": "query", "description": "Include software installed after specified date" } ] }, "docs": "Returns list software installed on devices" }, { "info": { "name": "Disk volumes report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/volumes", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "ts", "value": "", "type": "query", "description": "Monitoring timestamp filter" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" }, { "name": "include", "value": "", "type": "query", "description": "Additional information to include (bl - BitLocker status)" } ] }, "docs": "Returns list of disk volumes" }, { "info": { "name": "Windows services report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/queries/windows-services", "params": [ { "name": "df", "value": "", "type": "query", "description": "Device filter" }, { "name": "name", "value": "", "type": "query", "description": "Service name" }, { "name": "state", "value": "", "type": "query", "description": "Service state" }, { "name": "cursor", "value": "", "type": "query", "description": "Cursor name" }, { "name": "pageSize", "value": "", "type": "query", "description": "Limit number of records per page" } ] }, "docs": "Returns list of Windows Services and their statuses" } ] } ], "bundled": true }