diff options
| author | jejo86 <28619134+jejo86@users.noreply.github.com> | 2022-07-13 20:33:33 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-13 19:33:33 +0100 |
| commit | 2341032cf2d031e58710d82c9ee1d2360f9b82f9 (patch) | |
| tree | aca8b44aeeb9736492f9e182f67e98e32eaa1177 /changelog.d | |
| parent | Optimise room creation event lookups part 2 (#13224) (diff) | |
| download | synapse-2341032cf2d031e58710d82c9ee1d2360f9b82f9.tar.xz | |
Document advising against publicly exposing the Admin API and provide a usage example (#13231)
* Admin API request explanation improved Pointed out, that the Admin API is not accessible by default from any remote computer, but only from the PC `matrix-synapse` is running on. Added a full, working example, making sure to include the cURL flag `-X`, which needs to be prepended to `GET`, `POST`, `PUT` etc. and listing the full query string including protocol, IP address and port. * Admin API request explanation improved * Apply suggestions from code review Update changelog. Reword prose. Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
Diffstat (limited to 'changelog.d')
| -rw-r--r-- | changelog.d/13231.doc | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/changelog.d/13231.doc b/changelog.d/13231.doc new file mode 100644 index 0000000000..e750f9da49 --- /dev/null +++ b/changelog.d/13231.doc @@ -0,0 +1 @@ +Provide an example of using the Admin API. Contributed by @jejo86. |