MAmatrix
End-to-end encryption

Retrieve the keys from the backup for a given room.

Retrieve the keys from the backup for a given room.

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

Request

Path parameters

roomIdstring required

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

Query parameters

versionstring required

The backup from which to retrieve the key.

Response

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

sessionsobject required

A map of session IDs to key data.

Example response

{
  "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.