MatrixSynapse/docs/admin_api
Richard van der Hoff 59e2d2694d
Remove the requirement to authenticate for /admin/server_version. (#5122)
This endpoint isn't much use for its intended purpose if you first need to get
yourself an admin's auth token.

I've restricted it to the `/_synapse/admin` path to make it a bit easier to
lock down for those concerned about exposing this information. I don't imagine
anyone is using it in anger currently.
2019-05-07 09:29:30 +01:00
..
README.rst
account_validity.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
delete_group.md Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
media_admin_api.md Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
purge_history_api.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
purge_remote_media.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
register_api.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
server_notices.md Fix spelling in server notices admin API docs (#5142) 2019-05-06 22:15:02 +01:00
user_admin_api.rst Move admin API to a new prefix 2019-05-01 15:44:30 +01:00
version_api.rst Remove the requirement to authenticate for /admin/server_version. (#5122) 2019-05-07 09:29:30 +01:00

README.rst

Admin APIs
==========

This directory includes documentation for the various synapse specific admin
APIs available.

Only users that are server admins can use these APIs. A user can be marked as a
server admin by updating the database directly, e.g.:

``UPDATE users SET admin = 1 WHERE name = '@foo:bar.com'``

Restarting may be required for the changes to register.