Retrieves Drive-level BitLocker Encryption Details across Computer.

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API lists all drives along with BitLocker details, including encryption status, protection status, encryption method, and drive type. Results can be filtered by domain or specific resource ID.

Request URL

https://{serverurl}/api/1.4/bitlocker/bitlockerreports

Scope

DesktopCentralCloud.DataEncryption.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!
Content-TypestringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

residfilterstringOptional

Filter BitLocker Reports with particular resource id

domainfilterstringOptional

Get domain list from api/1.4/desktop/serverproperties

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/api/1.4/bitlocker/bitlockerreports \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
message_typestring

Module Code

message_responseJSON Object

Response.

Show Sub-Attributes
totalinteger

Total Number of Records.

limitinteger

Maximum number of records included in this single response.

bitlockerreportsJSON Array

Bitlockerreports.

Show Sub-Attributes
JSON Object
Show Sub-Attributes
encryption_statusinteger

0-FullyDecrypted,
1-FullyEncrypted,
2-EncryptionInProgress,
3-DecryptionInProgress,
4-EncryptionPaused,
5-DecryptionPaused

protection_statusinteger

0-Unprotected,
1-Protected,
2-Unknown

volume_typeinteger

0-Operating System Drive,
1-Data Drive

lock_statusinteger

0-UnLocked,
1-Locked

encryption_methodinteger

-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

device_idstring

BitLocker volume unique identifier

persistent_volume_idstring

Persistent volume GUID

managedcomputer.friendly_namestring

Computer friendly/host name

encryption_flag_idinteger

Encryption flag ID assigned internally

domain_netbios_namestring

Domain or Workgroup name

versioninteger

BitLocker schema version

resource_id_stringstring

Resource ID as string

drive_sizelong

Size of the drive in bytes

resource_idinteger

Resource ID of machine

os_namestring

Operating system name

resource_namestring

Computer resource name

customer_idinteger

Customer/account ID

bitlockerdrive.drive_letterstring

Drive letter of the volume

resource.resource_idinteger

Computer resource ID (redundant for joins)

pageinteger

Page Number.

message_versioninteger

Api Version.

statusinteger

Status of Api call.

response_codeinteger

Response code.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "response_code": 200,
    "message_type": "bitlockerreports",
    "message_response": {
      "total": 1,
      "bitlockerreports": [
        {
          "protection_status": 0,
          "volume_type": 1,
          "lock_status": 0,
          "encryption_method": 0,
          "device_id": "\\\\?\\Volume{12ed36-109e-4b15-99c7-5ef19cc23ca9}\\",
          "persistent_volume_id": "",
          "managedcomputer.friendly_name": "John",
          "encryption_flag_id": 0,
          "domain_netbios_name": "WORKGROUP",
          "version": 0,
          "encryption_status": 0,
          "resource_id_string": "111301",
          "drive_size": 249560035328,
          "resource_id": 111301,
          "os_name": "Windows 11 Professional Edition (x64)",
          "resource_name": "John",
          "customer_id": 1,
          "bitlockerdrive.drive_letter": "D:",
          "resource.resource_id": 111301
        }
      ],
      "limit": 25,
      "page": 1
    },
    "message_version": "1.4",
    "status": "success"
  }
                
Show full