summary refs log tree commit diff
diff options
context:
space:
mode:
authorTravis Ralston <travpc@gmail.com>2018-01-31 08:15:59 -0700
committerTravis Ralston <travpc@gmail.com>2018-01-31 08:15:59 -0700
commit3af53c183a0ab5d30ce0fb40e9b8eee8da7ad75a (patch)
tree63ddefbf85d74b0baf80ac4b096aab1953a51627
parentDocumentation and naming (diff)
downloadsynapse-3af53c183a0ab5d30ce0fb40e9b8eee8da7ad75a.tar.xz
Add admin api documentation for list media endpoint
Signed-off-by: Travis Ralston <travpc@gmail.com>
-rw-r--r--docs/admin_api/media_admin_api.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md
new file mode 100644
index 0000000000..abdbc1ea86
--- /dev/null
+++ b/docs/admin_api/media_admin_api.md
@@ -0,0 +1,23 @@
+# List all media in a room
+
+This API gets a list of known media in a room.
+
+The API is:
+```
+GET /_matrix/client/r0/admin/room/<room_id>/media
+```
+including an `access_token` of a server admin.
+
+It returns a JSON body like the following:
+```
+{
+    "local": [
+        "mxc://localhost/xwvutsrqponmlkjihgfedcba",
+        "mxc://localhost/abcdefghijklmnopqrstuvwx"
+    ],
+    "remote": [
+        "mxc://matrix.org/xwvutsrqponmlkjihgfedcba",
+        "mxc://matrix.org/abcdefghijklmnopqrstuvwx"
+    ]
+}
+```