MAmatrix
End-to-end encryption

Retrieve the keys from the backup.

Retrieve the keys from the backup.

get/_matrix/client/v3/room_keys/keys

Request

Query parameters

versionstring required

The backup from which to retrieve the keys.

Response

The key data. If no keys are found, then an object with an empty rooms property will be returned ({"rooms": {}}).

roomsobject required

A map of room IDs to room key backup data.

Example response

{
  "rooms": {
    "!room:example.org": {
      "sessions": {
        "sessionid1": {
          "first_message_index": 1,
          "forwarded_count": 0,
          "is_verified": true,
          "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.