--- title: "Device backup usage" method: GET path: "/v2/queries/backup/usage" tags: ["queries"] --- # Device backup usage `GET /v2/queries/backup/usage` Returns the backup usage by device ## Query parameters - `cursor` string - `pageSize` integer - `includeDeletedDevices` boolean ## Response `200` Returns a device backup usage report - object - `cursor` object - `name` string - `offset` integer - `count` integer - `expires` number, double - `results` object[] - `id` integer — Node (Device) identifier - `uid` string, uuid — Node (Device) UUID - `assignedOwnerUid` string, uuid — Node (Device) Owner UUID - `parentDeviceId` integer — Parent Node identifier - `organizationId` integer — Organization identifier - `locationId` integer — Location identifier - `nodeClass` 'WINDOWS_SERVER' | 'WINDOWS_WORKSTATION' | 'LINUX_WORKSTATION' | 'MAC' | 'ANDROID' | 'APPLE_IOS' | 'APPLE_IPADOS' | 'AOSP' | 'VMWARE_VM_HOST' | 'VMWARE_VM_GUEST' | 'HYPERV_VMM_HOST' | 'HYPERV_VMM_GUEST' | 'LINUX_SERVER' | 'MAC_SERVER' | 'CLOUD_MONITOR_TARGET' | 'NMS_SWITCH' | 'NMS_ROUTER' | 'NMS_FIREWALL' | 'NMS_PRIVATE_NETWORK_GATEWAY' | 'NMS_PRINTER' | 'NMS_SCANNER' | 'NMS_DIAL_MANAGER' | 'NMS_WAP' | 'NMS_IPSLA' | 'NMS_COMPUTER' | 'NMS_VM_HOST' | 'NMS_APPLIANCE' | 'NMS_OTHER' | 'NMS_SERVER' | 'NMS_PHONE' | 'NMS_VIRTUAL_MACHINE' | 'NMS_NETWORK_MANAGEMENT_AGENT' | 'UNMANAGED_DEVICE' | 'MANAGED_DEVICE' — Node Class - `nodeRoleId` integer — Node Role identifier - `rolePolicyId` integer — Node Role policy ID based on organization and location Policy Mapping - `policyId` integer — Assigned policy ID (overrides organization and location policy mapping) - `approvalStatus` 'PENDING' | 'STAGED' | 'APPROVED' | 'DECOMMISSIONED' — Approval Status - `offline` boolean — Is Offline? - `displayName` string — Display Name - `systemName` string — System Name - `dnsName` string — DNS Name - `netbiosName` string — NETBIOS Name - `created` number, double — Created - `lastContact` number, double — Last Contact - `lastUpdate` number, double — Last data submission timestamp - `userData` object — Custom attributes - `tags` string[] — Tags - `maintenance` object — Maintenance mode status - `status` 'PENDING' | 'IN_MAINTENANCE' | 'FAILED' — Maintenance mode status - `start` number, double — Maintenance mode start time - `end` number, double — Maintenance mode end time - `reasonMessage` string — Maintenance reason message - `references` object — Expanded entity references - `organization` object — Organization - `name` string — Organization full name - `description` string — Organization Description - `userData` object — Custom attributes - `nodeApprovalMode` 'AUTOMATIC' | 'MANUAL' | 'REJECT' — Device Approval Mode - `id` integer — Organization identifier - `location` object — Location - `name` string — Location name - `address` string — Address - `description` string — Description - `userData` object — Custom attributes - `id` integer — Location identifier - `rolePolicy` object — Assigned policy (overrides organization and location policy mapping) - `id` integer — Policy identifier - `parentPolicyId` integer — Parent Policy identifier - `name` string — Name - `description` string — Description - `nodeClass` 'WINDOWS_SERVER' | 'WINDOWS_WORKSTATION' | 'LINUX_WORKSTATION' | 'MAC' | 'ANDROID' | 'APPLE_IOS' | 'APPLE_IPADOS' | 'AOSP' | 'VMWARE_VM_HOST' | 'VMWARE_VM_GUEST' | 'HYPERV_VMM_HOST' | 'HYPERV_VMM_GUEST' | 'LINUX_SERVER' | 'MAC_SERVER' | 'CLOUD_MONITOR_TARGET' | 'NMS_SWITCH' | 'NMS_ROUTER' | 'NMS_FIREWALL' | 'NMS_PRIVATE_NETWORK_GATEWAY' | 'NMS_PRINTER' | 'NMS_SCANNER' | 'NMS_DIAL_MANAGER' | 'NMS_WAP' | 'NMS_IPSLA' | 'NMS_COMPUTER' | 'NMS_VM_HOST' | 'NMS_APPLIANCE' | 'NMS_OTHER' | 'NMS_SERVER' | 'NMS_PHONE' | 'NMS_VIRTUAL_MACHINE' | 'NMS_NETWORK_MANAGEMENT_AGENT' | 'UNMANAGED_DEVICE' | 'MANAGED_DEVICE' — Node Class - `updated` number, double — Last update timestamp - `nodeClassDefault` boolean — Is Default Policy for Node Class - `policy` object — Assigned policy (overrides organization and location policy mapping) - `id` integer — Policy identifier - `parentPolicyId` integer — Parent Policy identifier - `name` string — Name - `description` string — Description - `nodeClass` 'WINDOWS_SERVER' | 'WINDOWS_WORKSTATION' | 'LINUX_WORKSTATION' | 'MAC' | 'ANDROID' | 'APPLE_IOS' | 'APPLE_IPADOS' | 'AOSP' | 'VMWARE_VM_HOST' | 'VMWARE_VM_GUEST' | 'HYPERV_VMM_HOST' | 'HYPERV_VMM_GUEST' | 'LINUX_SERVER' | 'MAC_SERVER' | 'CLOUD_MONITOR_TARGET' | 'NMS_SWITCH' | 'NMS_ROUTER' | 'NMS_FIREWALL' | 'NMS_PRIVATE_NETWORK_GATEWAY' | 'NMS_PRINTER' | 'NMS_SCANNER' | 'NMS_DIAL_MANAGER' | 'NMS_WAP' | 'NMS_IPSLA' | 'NMS_COMPUTER' | 'NMS_VM_HOST' | 'NMS_APPLIANCE' | 'NMS_OTHER' | 'NMS_SERVER' | 'NMS_PHONE' | 'NMS_VIRTUAL_MACHINE' | 'NMS_NETWORK_MANAGEMENT_AGENT' | 'UNMANAGED_DEVICE' | 'MANAGED_DEVICE' — Node Class - `updated` number, double — Last update timestamp - `nodeClassDefault` boolean — Is Default Policy for Node Class - `role` object — Device Role - `id` integer — Device Role identifier - `name` string — Name - `description` string — Description - `nodeClass` 'WINDOWS_SERVER' | 'WINDOWS_WORKSTATION' | 'LINUX_WORKSTATION' | 'MAC' | 'ANDROID' | 'APPLE_IOS' | 'APPLE_IPADOS' | 'AOSP' | 'VMWARE_VM_HOST' | 'VMWARE_VM_GUEST' | 'HYPERV_VMM_HOST' | 'HYPERV_VMM_GUEST' | 'LINUX_SERVER' | 'MAC_SERVER' | 'CLOUD_MONITOR_TARGET' | 'NMS_SWITCH' | 'NMS_ROUTER' | 'NMS_FIREWALL' | 'NMS_PRIVATE_NETWORK_GATEWAY' | 'NMS_PRINTER' | 'NMS_SCANNER' | 'NMS_DIAL_MANAGER' | 'NMS_WAP' | 'NMS_IPSLA' | 'NMS_COMPUTER' | 'NMS_VM_HOST' | 'NMS_APPLIANCE' | 'NMS_OTHER' | 'NMS_SERVER' | 'NMS_PHONE' | 'NMS_VIRTUAL_MACHINE' | 'NMS_NETWORK_MANAGEMENT_AGENT' | 'UNMANAGED_DEVICE' | 'MANAGED_DEVICE' — Node Class - `custom` boolean — Is custom node role? - `chassisType` 'UNKNOWN' | 'DESKTOP' | 'LAPTOP' | 'MOBILE' — Chassis Type - `created` number, double — Date created - `nodeRoleParentId` integer — Node Role Parent Id - `icon` string — Icon - `backupUsage` object — Device Backup Usage - `revisionsCurrentSize` integer — Revisions current size - `revisionsPreviousSize` integer — Revisions previous size - `revisionsDeletedSize` integer — Revisions deleted size - `localFileFolderSize` integer — Revisions local file folder size - `localImageSize` integer — Revisions local image size - `localImageV2Size` integer — Revisions local image v2 size - `cloudFileFolderSize` integer — Revisions cloud file folder size - `cloudImageSize` integer — Revisions cloud image size - `cloudImageV2Size` integer — Revisions cloud image v2 size - `cloudNetworkShareSize` integer — Revisions cloud network share size - `lastSuccessfulBackupJob` number, double — Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true' - `lastFailedBackupJob` number, double — Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true' - `revisionsTotalSize` integer — Revisions total size - `cloudTotalSize` integer — Revisions cloud total size - `localTotalSize` integer — Revisions local total size - `warranty` object — Warranty Info - `startDate` number, double — Warranty Start Date (Seconds) - `endDate` number, double — Warranty End Date (Seconds) - `manufacturerFulfillmentDate` number, double — Manufacturer Fulfillment Date - `assignedOwner` object — Assigned device owner - `id` integer — User identifier - `uid` string, uuid — User universally unique identifier - `firstName` string - `lastName` string - `email` string - `phone` string - `enabled` boolean - `administrator` boolean - `permitAllClients` boolean - `notifyAllClients` boolean - `mustChangePw` boolean - `mfaConfigured` boolean - `userType` 'TECHNICIAN' | 'END_USER' - `invitationStatus` 'REGISTERED' | 'PENDING' | 'EXPIRED' - `organizationId` integer — Identifier of organization for end-users - `deviceIds` integer[] — Device IDs which end-user is authorized to access - `assignedDeviceIds` integer[] — Device IDs which user is assigned - `roles` string[] — A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true' - `backupBandwidthThrottle` object — Device Backup Bandwidth Throttle - `enabled` boolean — Whether bandwidth throttle is enabled/true or disabled/false - `workHoursKbps` integer — Bandwidth work hours limit - `nonWorkHoursKbps` integer — Bandwidth nonwork hours limit - `workHoursUserUnit` string — Bandwidth work hours unit - `nonWorkHoursUserUnit` string — Bandwidth nonwork hours unit - `workSchedule` object — Bandwidth work schedule - `endHour` integer — Work schedule end hour (0 to 23) - `endMinute` integer — Work schedule end minute (0 to 59) - `startHour` integer — Work schedule start hour (0 to 23) - `startMinute` integer — Work schedule start minute (0 to 59) - `weekDays` string[] — Work schedule week days list --- [API](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0.md) · [All operations](https://skmtc.net/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ninjarmm/ninjaone-public-api-2-0/versions/753f26d46650/schema)