From 9f273f34d4ac64ef9d47721b04187ed273fc998d Mon Sep 17 00:00:00 2001
From: erikjohnston
Listing all media that has been uploaded by a local user can be achieved through -the use of the List media of a user +the use of the List media of a user Admin API.
Quarantining media means that it is marked as inaccessible by users. It applies @@ -371,7 +371,7 @@ See also Purge Remote Media API.
server_name
: string - The name of your local server (e.g matrix.org
).before_ts
: string representing a positive integer - Unix timestamp in ms.
Files that were last used before this timestamp will be deleted. It is the timestamp of
-last access and not the timestamp creation. size_gt
: Optional - string representing a positive integer - Size of the media in bytes.
Files that are larger will be deleted. Defaults to 0
.keep_profiles
: Optional - string representing a boolean - Switch to also delete files
diff --git a/latest/admin_api/rooms.html b/latest/admin_api/rooms.html
index 6f8687e7e2..365339e4aa 100644
--- a/latest/admin_api/rooms.html
+++ b/latest/admin_api/rooms.html
@@ -184,19 +184,12 @@
The List Room admin API allows server admins to get a list of rooms on their server. There are various parameters available that allow for filtering and sorting the returned list. This API supports pagination.
-Parameters
The following query parameters are available:
from
- Offset in the returned list. Defaults to 0
.b
will reverse the above sort order. Defaults to search_term
- Filter rooms by their room name. Search term can be contained in any
part of the room name. Defaults to no filtering.Response
The following fields are possible in the JSON response body:
rooms
- An array of objects, each containing information about a room.
@@ -276,13 +270,11 @@ the value of next_batch
.prev_batch
for the from
value in the next request to
get the "previous page" of results.
The API is:
A standard request with no filtering:
GET /_synapse/admin/v1/rooms
-
-{}
-Response:
+A response body like the following is returned:
{
"rooms": [
{
@@ -325,10 +317,8 @@ get the "previous page" of results.
Filtering by room name:
GET /_synapse/admin/v1/rooms?search_term=TWIM
-
-{}
-Response:
+A response body like the following is returned:
{
"rooms": [
{
@@ -354,10 +344,8 @@ get the "previous page" of results.
Paginating through a list of rooms:
GET /_synapse/admin/v1/rooms?order_by=size
-
-{}
-Response:
+A response body like the following is returned:
{
"rooms": [
{
@@ -404,10 +392,8 @@ than returned in this request, and we need to make another request to get them.
To get the next batch of room results, we repeat our request, setting the from
parameter to the value of next_token
.
GET /_synapse/admin/v1/rooms?order_by=size&from=100
-
-{}
-Response:
+A response body like the following is returned:
{
"rooms": [
{
@@ -473,13 +459,10 @@ end of the list.
history_visibility
- Who can see the room history. One of: ["invited", "joined", "shared", "world_readable"].
state_events
- Total number of state_events of a room. Complexity of the room.
-Usage
-A standard request:
+The API is:
GET /_synapse/admin/v1/rooms/<room_id>
-
-{}
-Response:
+A response body like the following is returned:
{
"room_id": "!mscvqgqpHYjBGDxNym:matrix.org",
"name": "Music Theory",
@@ -507,13 +490,10 @@ end of the list.
members
- A list of all the members that are present in the room, represented by their ids.
total
- Total number of members in the room.
-Usage
-A standard request:
+The API is:
GET /_synapse/admin/v1/rooms/<room_id>/members
-
-{}
-Response:
+A response body like the following is returned:
{
"members": [
"@foo:matrix.org",
@@ -529,13 +509,10 @@ end of the list.
state
- The current state of the room at the time of request.
-Usage
-A standard request:
+The API is:
GET /_synapse/admin/v1/rooms/<room_id>/state
-
-{}
-Response:
+A response body like the following is returned:
{
"state": [
{"type": "m.room.create", "state_key": "", "etc": true},
@@ -589,7 +566,7 @@ server admin: see Admin API.
"new_room_id": "!newroomid:example.com"
}
-Parameters
+Parameters
The following parameters should be set in the URL:
room_id
- The ID of the room.
@@ -616,7 +593,7 @@ use this unless a regular purge
operation fails, as it could leave
clients in a confused state.
The JSON body must not be empty. The body must be at least {}
.
-Response
+Response
The following fields are returned in the JSON response body:
kicked_users
- An array of users (user_id
) that were kicked.
@@ -663,10 +640,10 @@ to recover at all:
If the user is not in the room, and it is not publicly joinable, then invite the user.
By default the server admin (the caller) is granted power, but another user can
optionally be specified, e.g.:
-
POST /_synapse/admin/v1/rooms/<room_id_or_alias>/make_room_admin
- {
- "user_id": "@foo:example.com"
- }
+POST /_synapse/admin/v1/rooms/<room_id_or_alias>/make_room_admin
+{
+ "user_id": "@foo:example.com"
+}
Forward Extremities Admin API
Enables querying and deleting forward extremities from rooms. When a lot of forward
@@ -674,7 +651,7 @@ extremities accumulate in a room, performance can become degraded. For details,
#1760.
Check for forward extremities
To check the status of forward extremities for a room:
- GET /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
+GET /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
A response as follows will be returned:
{
@@ -687,7 +664,7 @@ extremities accumulate in a room, performance can become degraded. For details,
"received_ts": 1611263016761
}
]
-}
+}
Deleting forward extremities
WARNING: Please ensure you know what you're doing and have read
@@ -695,7 +672,7 @@ the related issue #1
Under no situations should this API be executed as an automated maintenance task!
If a room has lots of forward extremities, the extra can be
deleted as follows:
- DELETE /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
+DELETE /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
A response as follows will be returned, indicating the amount of forward extremities
that were deleted.
diff --git a/latest/admin_api/server_notices.html b/latest/admin_api/server_notices.html
index ead8a872b8..96192a2d17 100644
--- a/latest/admin_api/server_notices.html
+++ b/latest/admin_api/server_notices.html
@@ -212,7 +212,7 @@ ignored in the same way as with PUT /_matrix/client/r0/rooms/{roomId}/send
}
Note that server notices must be enabled in homeserver.yaml
before this API
-can be used. See server_notices.md for more information.
+can be used. See the server notices documentation for more information.
--
cgit 1.5.1