BitLocker Reports


This API lists all the computer Drive's and related details like Drive Name, Drive size , Encryption status and percentage etc.,

 

  • Functionality
  • Retrieve the BitLocker Report details list.
  • HTTP Method 
  • GET
  • API URI
  • api/1.4/bitlocker/bitlockerreports
  • Filters 
  • domainfilter={String}:
    Get domain list from api/1.4/desktop/serverproperties

    residfilter={Numeric}:
    Filter BitLocker Reports with particular resource id
  • Response Parameters
  • encryption_status:
    0 - FullyDecrypted
    1 - FullyEncrypted
    2 - EncryptionInProgress
    3 - DecryptionInProgress
    4 - EncryptionPaused
    5 - DecryptionPaused

    protection_status:
    0 - Unprotected
    1 - Protected
    2 - Unknown

    volume_type:
    0 - Operating System Drive
    1 - Data Drive

    lock_status:
    0 - UnLocked
    1 - Locked

    encryption_method:
    -1 - UNKNOWN
    0 - None
    1 - AES_128_WITH_DIFFUSER
    2 - AES_256_WITH_DIFFUSER
    3 - AES_128
    4 - AES_256
    5 - HARDWARE_ENCRYPTION
    6 - XTS_AES_128
    7 - XTS_AES_256

Response Data

{   "message_type": "bitlockerreports",   "message_response": {     "total": 1,     "bitlockerreports": [       {         "protection_status": 1,         "volume_type": 0,         "lock_status": 0,         "encryption_method": 6,         "device_id": "\\\\?\\Volume{********-****-****-****-************}\\",         "persistent_volume_id": "{********-****-****-****-************}",         "managedcomputer.friendly_name": "masked-hostname",         "encryption_flag_id": 0,         "domain_netbios_name": "masked-domain",         "version": 2,         "encryption_status": 1,         "resource_id_string": "masked-id",         "drive_size": 511100858368,         "resource_id": "masked",         "os_name": "Windows 11 Professional Edition (x64)",         "resource_name": "masked-hostname",         "customer_id": "masked",         "bitlockerdrive.drive_letter": "C:"       }     ],     "limit": 25,     "page": 1   },   "message_version": "1.4",   "status": "success",   "response_code": 200 }