Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add some basic admin API docs #963

Merged
merged 2 commits into from
Jul 28, 2016
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/admin_api/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
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.
15 changes: 15 additions & 0 deletions docs/admin_api/purge_history_api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Purge History API
=================

The purge history API allows server admins to purge historic events from their
database, reclaiming disk space.

Depending on the amount of history being purged a call to the API may take
several minutes or longer. During this period users will not be able to
paginate further back in the room from the point being purged from.

The API is simply:

``POST /_matrix/client/r0/admin/purge_history/<room_id>/<event_id>``

including an ``access_token`` of a server admin.
19 changes: 19 additions & 0 deletions docs/admin_api/purge_remote_media.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Purge Remote Media API
======================

The purge remote media API allows server admins to purge old cached remote
media.

The API is::

POST /_matrix/client/r0/admin/purge_history/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really? surely purge_media or something?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooops, good spot. Fixed


{
"before_ts": <unix_timestamp_in_ms>
}

Which will remove all cached media that was last accessed before
``<unix_timestamp_in_ms>``.

If the user re-requests purged remote media, synapse will re-request the media
from the originating server.