forked-synapse/docs/admin_api
Aaron Raimist f6cbef6332
Add a note saying you need to manually reclaim disk space
People keep asking why their database hasn't gotten smaller after using this API.

Signed-off-by: Aaron Raimist <aaron@raim.ist>
2018-11-18 12:38:04 -06: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
README.rst Add some basic admin API docs 2016-07-28 14:56:09 +01:00
register_api.rst Update the admin register documentation to return a real user ID 2018-08-17 02:46:25 -06:00
user_admin_api.rst update doc for deactivate API 2018-06-26 10:42:50 +01:00

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.