API to CLI Mapping

The tables below show which Synapse Admin APIs are used by their corresponding synadm commands. The left column’s entries link to the official Synapse Admin API documentation, the right column’s entries point to the synadm CLI reference. To add missing entries to a table edit one of the CSV files in our documentation source directory and submit a pull request - see feature coverage documentation for details.

Account Validity

Synapse Admin API	synadm command(s)
Renew account

Background Updates

Synapse Admin API	synadm command(s)
Status
Enabled
Run

Delete Group

Synapse Admin API	synadm command(s)
Delete a local group	synadm group delete GROUP_ID

Event Reports

Synapse Admin API	synadm command(s)
Show reported events
Show details of a specific event report
Delete a specific event report

Experimental Features

Synapse Admin API	synadm command(s)
Enabling/Disabling Features
Listing Enabled Features

Media

Synapse Admin API	synadm command(s)
Querying media	—
List all media in a room	synadm media list -r
List all media uploaded by a user	synadm media list -u synadm user media -f
Quarantine media	—
Quarantining media by ID	synadm media quarantine -i
Remove media from quarantine by ID	synadm media unquarantine -i
Quarantining media in a room	synadm media quarantine -r
Quarantining all media of a user	synadm media quarantine -u
Protecting media from being quarantined	synadm media protect MEDIA_ID
Unprotecting media from being quarantined
Delete local media	—
Delete a specific local media	synadm media delete -i
Delete local media by date or size	synadm media delete -d synadm media delete --size
Delete media uploaded by a user
Purge Remote Media API	synadm media purge -d

Purge History

Synapse Admin API	synadm command(s)
Purge history	synadm history purge -i
Purge status query	synadm history purge-status PURGE_ID

Register Users

Synapse Admin API	synadm command(s)
Shared-Secret Registration

Registration Tokens

Synapse Admin API	synadm command(s)
Registration token objects	—
List all tokens	synadm regtok list -v
Get one token	synadm regtok details TOKEN
Create token	synadm regtok new -n
Update token	synadm regtok update TOKEN
Delete token	synadm regtok delete TOKEN

Manipulate Room Membership

Synapse Admin API	synadm command(s)
Edit Room Membership API	synadm room join ROOM_ID_OR_ALIAS

Rooms

Synapse Admin API	synadm command(s)
List Room API	synadm room list -f
Room Details API	synadm room details ROOM_ID
Room Members API	synadm room members ROOM_ID
Room State API	synadm room state ROOM_ID
Room Messages API
Room Timestamp to Event API
Block Room API	—
Block or unblock a room	synadm room block -b synadm room block -u
Get block status	synadm room block-status ROOM_ID
Delete Room API	—
Version 1 (old version)	synadm room delete --v1
Version 2 (new version)	synadm room delete ROOM_ID
Status of deleting rooms	—
Query by room_id	synadm room delete-status -r
Query by delete_id	synadm room delete-status -d
Undoing room deletions
Make Room Admin API	synadm room make-admin -u
Forward Extremities Admin API
Check for forward extremities
Deleting forward extremities
Event Context API

Server Notices

Synapse Admin API	synadm command(s)
Server Notices	synadm notice send TO

Statistics

Synapse Admin API	synadm command(s)
Users’ media usage statistics
Get largest rooms by size in database

Users

Synapse Admin API	synadm command(s)
Query User Account	synadm user details USER_ID
Create or modify account	synadm user modify USER_ID
List Accounts	—
List Accounts (V2)	synadm user list -f
List Accounts (V3)
Query current sessions for a user	synadm user whois USER_ID
Deactivate Account	synadm user deactivate USER_ID
Reset password	synadm user password USER_ID
Get whether a user is a server administrator or not
Change whether a user is a server administrator or not
List room memberships of a user	synadm user membership USER_ID
Account Data
User media	—
List media uploaded by a user	synadm user media -f synadm media list -u
Delete media uploaded by a user
Login as a user	synadm user login USER_ID
Allow replacing master cross-signing key without…
User devices	—
List all devices	synadm user prune-devices --list-only
Create a device
Delete multiple devices	synadm user prune-devices -d synadm user prune-devices -s
Show a device	synadm user prune-devices --list-only (-i)
Update a device
Delete a device	synadm user prune-devices -i
List all pushers
Controlling whether a user is shadow-banned	synadm user shadow-ban USER_ID synadm user shadow-ban --unban
Override ratelimiting for users	—
Get status of ratelimit
Set ratelimit
Delete ratelimit
Check username availability
Find a user based on their ID in an auth provider	synadm user 3pid ADDRESS
Find a user based on their Third Party ID	synadm user auth-provider EXTERNAL_USER_ID

Server Version

Synapse Admin API	synadm command(s)
Version API	synadm version

Federation

Synapse Admin API	synadm command(s)
List of destinations
Destination Details API
Destination rooms
Reset connection timeout

Miscellaneous

Description	synadm command(s)
The Configurator	synadm config -u
Any Synapse Admin API	synadm raw ENDPOINT
Native Matrix API Helpers	—
Matrix User Login	synadm matrix login USER_ID
Any Matrix API	synadm matrix raw ENDPOINT