MAmatrix
End-to-end encryption

Get information about an existing backup.

Get information about an existing backup.

get/_matrix/client/v3/room_keys/version/{version}

Request

Path parameters

versionstring required

The backup version to get, as returned in the version parameter of the response in POST /_matrix/client/v3/room_keys/version or this endpoint.

Response

The information about the requested backup.

algorithm'm.megolm_backup.v1.curve25519-aes-sha2' required

The algorithm used for storing backups.

auth_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.

countinteger required

The number of keys stored in the backup.

etagstring required

An opaque string representing stored keys in the backup. Clients can compare it with the etag value they received in the request of their last key storage request. If not equal, another client has modified the backup.

versionstring required

The backup version.

Example response

{
  "algorithm": "m.megolm_backup.v1.curve25519-aes-sha2",
  "auth_data": {
    "public_key": "abcdefg",
    "signatures": {
      "@alice:example.org": {
        "ed25519:deviceid": "signature"
      }
    }
  },
  "count": 42,
  "etag": "anopaquestring",
  "version": "1"
}

Changes

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