diff options
author | Mark Felder <feld@FreeBSD.org> | 2020-08-25 11:57:23 -0500 |
---|---|---|
committer | Mark Felder <feld@FreeBSD.org> | 2020-08-25 11:57:23 -0500 |
commit | 479578b148f28f311a7d20f6da99bbc0dab1652c (patch) | |
tree | 2b0e5bfe6bfa5c4b954b9442d4d2a1d4ad4bc8cf /docs/API/admin_api.md | |
parent | 98f8851f29f940051656caa1715820bce70f8c29 (diff) | |
parent | 361aa22e2862c1c914baf8257fdc8b20cbc7941d (diff) | |
download | pleroma-479578b148f28f311a7d20f6da99bbc0dab1652c.tar.gz |
Merge branch 'develop' into feld-2168-media-preview-proxy
Diffstat (limited to 'docs/API/admin_api.md')
-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` |