MAmatrix
End-to-end encryption

Retrieve a key from the backup.

Retrieve a key from the backup.

get/_matrix/client/v3/room_keys/keys/{roomId}/{sessionId}

Request

Path parameters

roomIdstring required

The ID of the room that the requested key is for.

sessionIdstring required

The ID of the megolm session whose key is requested.

Query parameters

versionstring required

The backup from which to retrieve the key.

Response

The key data

first_message_indexinteger required

The index of the first message in the session that the key can decrypt.

forwarded_countinteger required

The number of times this key has been forwarded via key-sharing between devices.

is_verifiedboolean required

Whether the device backing up the key verified the device that the key is from.

session_dataobject required

Algorithm-dependent data. See the documentation for the backup algorithms in Server-side key backups for more information on the expected format of the data.

Example response

{
  "first_message_index": 1,
  "session_data": {
    "ciphertext": "base64+ciphertext+of+JSON+data",
    "ephemeral": "base64+ephemeral+key",
    "mac": "base64+mac+of+ciphertext"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.