diff options
author | feld <feld@feld.me> | 2020-08-24 17:03:18 +0000 |
---|---|---|
committer | feld <feld@feld.me> | 2020-08-24 17:03:18 +0000 |
commit | d39abd02acf75d5f653052b0d4b579164a7fde5b (patch) | |
tree | ab65cec2cd95b8449e31e48ad545a442ccedbaf1 /docs/API | |
parent | e1c8c599ff12699692ec7f06efc44064ee5ecb0b (diff) | |
parent | 13f6029b4b7aad145c68fe804d34fbff9a371d36 (diff) | |
download | pleroma-d39abd02acf75d5f653052b0d4b579164a7fde5b.tar.gz |
Merge branch 'relay-fix-admin-fe' into 'develop'
Relay fix for admin-fe
See merge request pleroma/pleroma!2902
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` |