mirror of
https://github.com/element-hq/synapse
synced 2024-09-10 09:35:12 +00:00
The Delete Room admin API allows server admins to remove rooms from server
and block these rooms.
`DELETE /_synapse/admin/v1/rooms/<room_id>`
It is a combination and improvement of "[Shutdown room](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/shutdown_room.md)" and "[Purge room](https://github.com/matrix-org/synapse/blob/develop/docs/admin_api/purge_room.md)" API.
Fixes: #6425
It also fixes a bug in [synapse/storage/data_stores/main/room.py](synapse/storage/data_stores/main/room.py) in ` get_room_with_stats`.
It should return `None` if the room is unknown. But it returns an `IndexError`.
|
||
---|---|---|
.. | ||
account_validity.rst | ||
delete_group.md | ||
media_admin_api.md | ||
purge_history_api.rst | ||
purge_remote_media.rst | ||
purge_room.md | ||
README.rst | ||
register_api.rst | ||
room_membership.md | ||
rooms.md | ||
server_notices.md | ||
shutdown_room.md | ||
user_admin_api.rst | ||
version_api.rst |
Admin APIs ========== This directory includes documentation for the various synapse specific admin APIs available. Authenticating as a server admin -------------------------------- Many of the API calls in the admin api will require an `access_token` for a server admin. (Note that a server admin is distinct from a room admin.) A user can be marked as a server admin by updating the database directly, e.g.: .. code-block:: sql UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'; A new server admin user can also be created using the ``register_new_matrix_user`` script. Finding your user's `access_token` is client-dependent, but will usually be shown in the client's settings. Once you have your `access_token`, to include it in a request, the best option is to add the token to a request header: ``curl --header "Authorization: Bearer <access_token>" <the_rest_of_your_API_request>`` Fore more details, please refer to the complete `matrix spec documentation <https://matrix.org/docs/spec/client_server/r0.5.0#using-access-tokens>`_.