This repository has been archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add some basic admin API docs #963
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ | ||
|
||
{ | ||
"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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ooops, good spot. Fixed