Retrieves BitLocker Recovery Keys.

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 BitLocker recovery key information for all computers. Results can be filtered by domain, computer name, or key protector ID.

Request URL

https://{serverurl}/api/1.4/bitlocker/recoverykeydetails Copied!

Scope

DesktopCentralCloud.DataEncryption.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

keyProtectorIdstringOptional

Filter Recovery Key details with Key protector Id

compNamestringOptional

Filter Recovery Key details with particular computer name

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/recoverykeydetails \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json'

Response Parameters

- HTTP code 200

Response Body - application/json
string

Sample Response: HTTP 200

Copied!
  {
    "response_code": 200,
    "message_type": "recoverykeydetails",
    "message_response": {
      "recoverykeydetails": [
        {
          "key_protector_id": "{0977480D-C76E-4B8E-B750-123BCCCE47C}",
          "recovery_key": "223575-265432-890982-416042-399949-366960-389807",
          "drive_letter": "C:",
          "name": "SYS-1",
          "resource_id": 110707,
          "domain_netbios_name": "WORKGROUP",
          "customer_id": 1
        }
      ]
    },
    "message_version": "1.4",
    "status": "success"
  }
                
▼ Show full