synapse

History

Shay f1695ac20e Add an admin API to get the space hierarchy (#19021 ) It is often useful when investigating a space to get information about that space and it's children. This PR adds an Admin API to return information about a space and it's children, regardless of room membership. Will not fetch information over federation about remote rooms that the server is not participating in.		2025-10-24 15:32:16 -05:00
..
account_validity.md	Add warnings about MSC3861 on certain APIs. (#16168 )	2023-08-25 07:25:34 -04:00
client_server_api_extensions.md	Allow admins to see policy server-flagged events (#18585 )	2025-07-29 19:57:33 +01:00
event_reports.md	Stop sending or processing the `origin` field in PDUs (#18418 )	2025-07-01 12:04:23 +01:00
experimental_features.md	Add experimental support for MSC4222 (#17888 )	2024-11-05 14:45:57 +00:00
fetch_event.md	Add an Admin API to fetch an event by ID (#18963 )	2025-10-08 11:38:15 +01:00
media_admin_api.md	Add an Admin API to query a piece of local or cached remote media by ID (#18911 )	2025-09-23 16:25:56 -05:00
purge_history_api.md
README.rst	Update book location	2023-12-13 16:15:22 +00:00
register_api.md	Add warnings about MSC3861 on certain APIs. (#16168 )	2023-08-25 07:25:34 -04:00
room_membership.md	Fix various typos in docs (#17114 )	2024-04-26 18:10:45 +00:00
rooms.md	Add an admin API to get the space hierarchy (#19021 )	2025-10-24 15:32:16 -05:00
scheduled_tasks.md	Fix typo in doc for Scheduled Tasks Admin API (#18384 )	2025-05-02 12:14:31 +01:00
server_notices.md
statistics.md
user_admin_api.md	Add an option to issue redactions as admin user on admin redaction endpoint (#18671 )	2025-07-21 16:40:45 +00:00
version_api.md	Remove Python version from `/_synapse/admin/v1/server_version` (#16380 )	2023-10-02 09:07:53 -04:00

README.rst

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

**Note**: The latest documentation can be viewed `here <https://element-hq.github.io/synapse>`_.
See `docs/README.md <../README.md>`_ for more information.

**Please update links to point to the website instead.** Existing files in this directory
are preserved to maintain historical links, but may be moved in the future.

This directory includes documentation for the various synapse specific admin
APIs available. Updates to the existing Admin API documentation should still
be made to these files, but any new documentation files should instead be placed under
`docs/usage/administration/admin_api <../usage/administration/admin_api>`_.