---
title: "Disk volumes report"
method: GET
path: "/v2/queries/volumes"
tags: ["queries"]
---

# Disk volumes report

`GET /v2/queries/volumes`

## Request

- Base URL: `https://app.ninjarmm.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.ninjarmm.com/v2/queries/volumes`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `sessionKey`
- TypeScript: <https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/docs/v2/queries/volumes/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns list of disk volumes

## Query parameters

- `df` string
- `ts` string
- `cursor` string
- `pageSize` integer
- `include` string

## Response `default`

default response

- object
  - `cursor` object
    - `name` string
    - `offset` integer
    - `count` integer
    - `expires` number, double
  - `results` object[]
    - `name` string: Name
    - `driveLetter` string: Drive Letter
    - `label` string: Volume Label
    - `deviceType` string: Device Type
    - `fileSystem` string: File System Type
    - `autoMount` boolean: Automatically Mounted
    - `compressed` boolean: Compressed
    - `capacity` integer: Capacity (bytes)
    - `freeSpace` integer: Free Space (bytes)
    - `serialNumber` string: Serial Number
    - `bitLockerStatus` object: BitLocker Status
      - `conversionStatus` 'FULLY_DECRYPTED' | 'FULLY_ENCRYPTED' | 'ENCRYPTION_IN_PROGRESS' | 'DECRYPTION_IN_PROGRESS' | 'ENCRYPTION_PAUSED' | 'DECRYPTION_PAUSED' | 'UNKNOWN': Volume encryption or decryption status.
      - `encryptionMethod` 'NONE' | 'AES_128_WITH_DIFFUSER' | 'AES_256_WITH_DIFFUSER' | 'AES_128' | 'AES_256' | 'HARDWARE_ENCRYPTION' | 'XTS_AES_128' | 'XTS_AES_256' | 'UNKNOWN': Indicated the encryption algorithm and key size used on the volume
      - `protectionStatus` 'UNPROTECTED' | 'PROTECTED' | 'UNKNOWN' | 'PENDING': indicates whether the volume and its encryption key (if any) are secured.
      - `lockStatus` 'UNKNOWN' | 'UNLOCKED' | 'LOCKED': Indicates whether the contents of the volume are accessible from Windows
      - `initializedForProtection` boolean: Is initialized for protection
    - `deviceId` integer: Device identifier
    - `timestamp` number, double: Date/Time when data was collected/updated

---

[API](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0.md) - [All operations](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/llms.txt) - [OpenAPI document](https://skmtc.dev/ninjarmm/apis/ninjaone-public-api-2-0/revisions/5ce571d1bb71?raw)