element-synapse/docs/admin_api
Travis Ralston 0f2b29511f
Some checks are pending
Build docker images / Build and push image for ${{ matrix.platform }} (linux/amd64, ubuntu-24.04, linux-amd64) (push) Waiting to run
Build docker images / Build and push image for ${{ matrix.platform }} (linux/arm64, ubuntu-24.04-arm, linux-arm64) (push) Waiting to run
Build docker images / Push merged images to ${{ matrix.repository }} (docker.io/matrixdotorg/synapse) (push) Blocked by required conditions
Build docker images / Push merged images to ${{ matrix.repository }} (ghcr.io/element-hq/synapse) (push) Blocked by required conditions
Deploy the documentation / Calculate variables for GitHub Pages deployment (push) Waiting to run
Deploy the documentation / GitHub Pages (push) Blocked by required conditions
Build release artifacts / Calculate list of debian distros (push) Waiting to run
Build release artifacts / Build .deb packages (push) Blocked by required conditions
Build release artifacts / Build wheels on ${{ matrix.os }} (${{ startsWith(github.ref, 'refs/pull/') }}, ubuntu-24.04) (push) Waiting to run
Build release artifacts / Build wheels on ${{ matrix.os }} (${{ startsWith(github.ref, 'refs/pull/') }}, ubuntu-24.04-arm) (push) Waiting to run
Build release artifacts / Build sdist (push) Waiting to run
Build release artifacts / Attach assets to release (push) Blocked by required conditions
Schema / Ensure Synapse config schema is valid (push) Waiting to run
Schema / Ensure generated documentation is up-to-date (push) Waiting to run
Tests / changes (push) Waiting to run
Tests / check-sampleconfig (push) Blocked by required conditions
Tests / check-schema-delta (push) Blocked by required conditions
Tests / check-lockfile (push) Waiting to run
Tests / lint (push) Blocked by required conditions
Tests / Typechecking (push) Blocked by required conditions
Tests / lint-crlf (push) Waiting to run
Tests / lint-newsfile (push) Waiting to run
Tests / lint-clippy (push) Blocked by required conditions
Tests / lint-clippy-nightly (push) Blocked by required conditions
Tests / lint-rust (push) Blocked by required conditions
Tests / lint-rustfmt (push) Blocked by required conditions
Tests / lint-readme (push) Blocked by required conditions
Tests / linting-done (push) Blocked by required conditions
Tests / calculate-test-jobs (push) Blocked by required conditions
Tests / trial (push) Blocked by required conditions
Tests / trial-olddeps (push) Blocked by required conditions
Tests / trial-pypy (all, pypy-3.10) (push) Blocked by required conditions
Tests / sytest (push) Blocked by required conditions
Tests / export-data (push) Blocked by required conditions
Tests / portdb (14, 3.10) (push) Blocked by required conditions
Tests / portdb (17, 3.14) (push) Blocked by required conditions
Tests / complement (monolith, Postgres) (push) Blocked by required conditions
Tests / complement (monolith, SQLite) (push) Blocked by required conditions
Tests / complement (workers, Postgres) (push) Blocked by required conditions
Tests / cargo-test (push) Blocked by required conditions
Tests / cargo-bench (push) Blocked by required conditions
Tests / tests-done (push) Blocked by required conditions
Allow admins to bypass the quarantine check on media downloads (#19275)
Co-authored-by: turt2live <1190097+turt2live@users.noreply.github.com>
Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
2025-12-15 17:23:33 +00: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 Allow admins to bypass the quarantine check on media downloads (#19275) 2025-12-15 17:23:33 +00:00
purge_history_api.md Fix broken links in the Synapse documentation. (#14744) 2023-01-05 18:18:00 +00:00
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 Fix documented path to largest rooms statistics endpoint. (#15560) 2023-05-10 13:00:27 +00:00
user_admin_api.md minor grammar fix 2025-12-12 13:36:34 +00:00
version_api.md Remove Python version from /_synapse/admin/v1/server_version (#16380) 2023-10-02 09:07:53 -04:00

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>`_.