GetRecoveryKey

Will retrieve the BitLocker recovery keys for encrypted volumes. Can retrieve keys for specific drives or auto-discover all encrypted volumes.

Syntax

Method ID

#define WAAPI_MID_GET_RECOVERY_KEY 1034

JSON Input Structure

{
  "input": {
    "method": 1034,
    "signature": number,
    "volumes": [
      string,
      ...
    ]
  }
}

Input Properties

Parameter	Type	Description
`volumes`	array<string>	(optional) Array of drive letters to retrieve recovery keys for (e.g., ['C:', 'D:']).

JSON Output Structure

{
  "result": {
    "method": 1034,
    "code": number,
    "timing": number,
    "timestamp": string,
    "disk_encryption": [
      {
        "volume": string,
        "code": number,
        "recovery_password": string,
        "key_protector_id": string,
        "error_message": string
      },
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.disk_encryption`	array<object>	An array of recovery key information for each encrypted volume.
`result.disk_encryption.volume`	string	The volume of the encrypted volume (e.g., 'C:', 'D:').
`result.disk_encryption.code`	number	The result code for this specific drive (0 for success).
`result.disk_encryption.recovery_password`	string	(optional) The numeric recovery password. Format: XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX-XXXXXX.
`result.disk_encryption.key_protector_id`	string	(optional) The unique identifier for the key protector.
`result.disk_encryption.error_message`	string	(optional) Error message if retrieval failed for this volume.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​