diff options
author | lain <lain@soykaf.club> | 2020-09-04 18:22:24 +0200 |
---|---|---|
committer | lain <lain@soykaf.club> | 2020-09-04 18:22:24 +0200 |
commit | bb007b9298b514c305dff944bef8463ffe1596a8 (patch) | |
tree | c07d067339fd81f45e1b348f684b63ce412ac46f /docs/API | |
parent | 4fd705e832702f24377d6273a47cfc3752e1241b (diff) | |
parent | 2b04cdf407c9ce4134a0fe448b7f8dff7f6ff57f (diff) | |
download | pleroma-bb007b9298b514c305dff944bef8463ffe1596a8.tar.gz |
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into matrix-explorations
Diffstat (limited to 'docs/API')
-rw-r--r-- | docs/API/admin_api.md | 48 |
1 files changed, 35 insertions, 13 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index 05e63b528..c0ea074f0 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -313,31 +313,53 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - On failure: `Not found` - On success: JSON array of user's latest statuses +## `GET /api/pleroma/admin/relay` + +### List Relays + +Params: none +Response: + +* On success: JSON array of relays + +```json +[ + {"actor": "https://example.com/relay", "followed_back": true}, + {"actor": "https://example2.com/relay", "followed_back": false} +] +``` + ## `POST /api/pleroma/admin/relay` ### Follow a Relay -- Params: - - `relay_url` -- Response: - - On success: URL of the followed relay +Params: + +* `relay_url` + +Response: + +* On success: relay json object + +```json +{"actor": "https://example.com/relay", "followed_back": true} +``` ## `DELETE /api/pleroma/admin/relay` ### Unfollow a Relay -- Params: - - `relay_url` -- Response: - - On success: URL of the unfollowed relay +Params: -## `GET /api/pleroma/admin/relay` +* `relay_url` -### List Relays +Response: -- Params: none -- Response: - - On success: JSON array of relays +* On success: URL of the unfollowed relay + +```json +{"https://example.com/relay"} +``` ## `POST /api/pleroma/admin/users/invite_token` |