Raw Command#
synadm raw#
Issue a custom request to the Synapse Admin API.
The endpoint argument is the part of the URL _after_ the configured
“Synapse base URL” and “Synapse Admin API path” (see synadm config
).
A get request to the “Query User Account API” would look like this:
synadm raw v2/users/%40testuser%3Aexample.org
. URL encoding must be
handled at this point. Consider enabling debug outputs via synadm’s global
flag -vv
synadm raw [OPTIONS] ENDPOINT
Options
- -m, --method <method>#
The HTTP method used for the request.
- Default:
get
- Options:
get | post | put | delete
- -d, --data <data>#
The JSON string sent in the body of post, put and delete requests - provided as a string. Make sure to escape it from shell interpretation by using single quotes. E.g ‘{“key1”: “value1”, “key2”: 123}’
- Default:
{}
- -f, --data-file <data_file>#
Read JSON data from file. To read from stdin use “-” as the filename argument.
Arguments
- ENDPOINT#
Required argument