summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2021-02-02 16:06:59 +0000
committerErik Johnston <erik@matrix.org>2021-02-02 16:06:59 +0000
commit6e774373c2268ee72d03aaa0461b1adaf62e78b9 (patch)
tree1f891f245f88f8215acaab51095be6b1564d0ea7 /docs/admin_api
parentMerge remote-tracking branch 'origin/develop' into matrix-org-hotfixes (diff)
parentUpdate changelog (diff)
downloadsynapse-6e774373c2268ee72d03aaa0461b1adaf62e78b9.tar.xz
Merge remote-tracking branch 'origin/release-v1.27.0' into matrix-org-hotfixes
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/rooms.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md

index f34cec1ff7..3832b36407 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md
@@ -368,6 +368,36 @@ Response: } ``` +# Room State API + +The Room State admin API allows server admins to get a list of all state events in a room. + +The response includes the following fields: + +* `state` - The current state of the room at the time of request. + +## Usage + +A standard request: + +``` +GET /_synapse/admin/v1/rooms/<room_id>/state + +{} +``` + +Response: + +```json +{ + "state": [ + {"type": "m.room.create", "state_key": "", "etc": true}, + {"type": "m.room.power_levels", "state_key": "", "etc": true}, + {"type": "m.room.name", "state_key": "", "etc": true} + ] +} +``` + # Delete Room API The Delete Room admin API allows server admins to remove rooms from server