MatrixSynapse

History

Joseph Weston 144cbfd650 add API documentation Signed-off-by: Joseph Weston <joseph@weston.cloud>		2019-03-02 03:07:04 +01:00
..
README.rst	Add some basic admin API docs	2016-07-28 14:56:09 +01:00
media_admin_api.md	Add admin api documentation for list media endpoint	2018-01-31 08:15:59 -07:00
purge_history_api.rst	Add a note saying you need to manually reclaim disk space	2018-11-18 12:38:04 -06:00
purge_remote_media.rst	fix doc for purge_media_cache	2017-01-20 12:15:50 +00:00
register_api.rst	create support user (#4141 )	2018-12-14 18:20:59 +00:00
user_admin_api.rst	update doc for deactivate API	2018-06-26 10:42:50 +01:00
version_api.rst	add API documentation	2019-03-02 03:07:04 +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.