BitLocker recovery key details
bitlocker_recovery_key_detailsRetrieve BitLocker recovery key records for managed computers, filterable by computer, domain, or key protector ID. Use to unlock drives when recovery is genuinely needed.
Instructions
Retrieves BitLocker recovery key records (key protector ID, drive letter, computer, domain) for managed computers, filterable by key protector ID, computer name, or domain. SENSITIVE: this endpoint returns BitLocker recovery keys — secrets that unlock encrypted drives. Only use it when key retrieval is genuinely needed (e.g. recovering a locked-out drive), never for routine reporting. The default response deliberately omits the recovery_key field; set raw: true to expose the actual key material.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | Set to true to include the recovery_key field (the actual BitLocker recovery password) in each record. Off by default so key material is never exposed unless genuinely required. | |
| compName | No | Filter by computer name. | |
| domainFilter | No | Filter by NetBIOS domain name. | |
| keyProtectorId | No | Filter to a single key protector by its key protector ID (GUID). |