summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2025-01-08 07:38:26 -0800
committerGitHub <noreply@github.com>2025-01-08 15:38:26 +0000
commite34fd1228df8f20ae56896c3cbf2b15efcfaa06a (patch)
treee83e76e54995550f49272492049700717d02dde3 /docs/admin_api
parentDrop unstable MSC4151 implementation (#18052) (diff)
downloadsynapse-e34fd1228df8f20ae56896c3cbf2b15efcfaa06a.tar.xz
Add the ability to filter by state event type on admin room state endpoint (#18035)
Adds a query param `type` to `/_synapse/admin/v1/rooms/{room_id}/state`
that filters the state event query by state event type.

---------

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/rooms.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md

index 8e3a367e90..bfc2cd4376 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md
@@ -385,6 +385,13 @@ The API is: GET /_synapse/admin/v1/rooms/<room_id>/state ``` +**Parameters** + +The following query parameter is available: + +* `type` - The type of room state event to filter by, eg "m.room.create". If provided, only state events + of this type will be returned (regardless of their `state_key` value). + A response body like the following is returned: ```json